Class: Aws::Synthetics::Types::CreateCanaryRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-synthetics/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#artifact_config ⇒ Types::ArtifactConfigInput

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Returns:



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#artifact_s3_location ⇒ String

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can’t include a period (.).

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#code ⇒ Types::CanaryCodeInput

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

Returns:



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ String

The ARN of the IAM role to be used to run the canary. This role must already exist, and must include ‘lambda.amazonaws.com` as a principal in the trust policy. The role must also have the following permissions:

  • ‘s3:PutObject`

  • ‘s3:GetBucketLocation`

  • ‘s3:ListAllMyBuckets`

  • ‘cloudwatch:PutMetricData`

  • ‘logs:CreateLogGroup`

  • ‘logs:CreateLogStream`

  • ‘logs:PutLogEvents`

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#failure_retention_period_in_days ⇒ Integer

The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Returns:

  • (Integer) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see [Security Considerations for Synthetics Canaries].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#resources_to_replicate_tags ⇒ Array<String>

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value ‘lambda-function`.

If you specify this parameter and don’t specify any tags in the ‘Tags` parameter, the canary creation fails.

Returns:

  • (Array<String>) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#run_config ⇒ Types::CanaryRunConfigInput

A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.

The environment variables keys and values are not encrypted. Do not store sensitive information in this field.

Returns:



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_version ⇒ String

Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see [ Canary Runtime Versions].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::CanaryScheduleInput

A structure that contains information about how often the canary is to run and when these test runs are to stop.

Returns:



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#success_retention_period_in_days ⇒ Integer

The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Returns:

  • (Integer) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value ‘lambda-function`.

Returns:

  • (Hash<String,String>) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfigInput

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see [ Running a Canary in a VPC].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html

Returns:



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/aws-sdk-synthetics/types.rb', line 812

class CreateCanaryRequest < Struct.new(
  :name,
  :code,
  :artifact_s3_location,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :runtime_version,
  :vpc_config,
  :resources_to_replicate_tags,
  :tags,
  :artifact_config)
  SENSITIVE = []
  include Aws::Structure
end