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

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

Overview

Note:

When making an API call, you may pass CreateCanaryRequest data as a hash:

{
  name: "CanaryName", # required
  code: { # required
    s3_bucket: "String",
    s3_key: "String",
    s3_version: "String",
    zip_file: "data",
    handler: "String", # required
  },
  artifact_s3_location: "String", # required
  execution_role_arn: "RoleArn", # required
  schedule: { # required
    expression: "String", # required
    duration_in_seconds: 1,
  },
  run_config: {
    timeout_in_seconds: 1,
    memory_in_mb: 1,
    active_tracing: false,
  },
  success_retention_period_in_days: 1,
  failure_retention_period_in_days: 1,
  runtime_version: "String", # required
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#artifact_s3_locationString

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.

Returns:

  • (String)


663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#codeTypes::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.



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arnString

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)


663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_retention_period_in_daysInteger

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)


663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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.

Returns:

  • (String)


663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#run_configTypes::CanaryRunConfigInput

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



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_versionString

Specifies the runtime version to use for the canary. Currently, the only valid values are syn-nodejs-2.0, syn-nodejs-2.0-beta, and syn-1.0. For more information about runtime versions, see Canary Runtime Versions.

Returns:

  • (String)


663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::CanaryScheduleInput

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



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#success_retention_period_in_daysInteger

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)


663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<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.

Returns:

  • (Hash<String,String>)


663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configTypes::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.



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 663

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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end