You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Synthetics::Types::UpdateCanaryRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Synthetics::Types::UpdateCanaryRequest
- Defined in:
- (unknown)
Overview
When passing UpdateCanaryRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
name: "CanaryName", # required
code: {
s3_bucket: "String",
s3_key: "String",
s3_version: "String",
zip_file: "data",
handler: "String", # required
},
execution_role_arn: "RoleArn",
runtime_version: "String",
schedule: {
expression: "String", # required
duration_in_seconds: 1,
},
run_config: {
timeout_in_seconds: 1,
memory_in_mb: 1,
active_tracing: false,
environment_variables: {
"EnvironmentVariableName" => "EnvironmentVariableValue",
},
},
success_retention_period_in_days: 1,
failure_retention_period_in_days: 1,
vpc_config: {
subnet_ids: ["SubnetId"],
security_group_ids: ["SecurityGroupId"],
},
}
Instance Attribute Summary collapse
-
#code ⇒ Types::CanaryCodeInput
A structure that includes the entry point from which the canary should start running your script.
-
#execution_role_arn ⇒ String
The ARN of the IAM role to be used to run the canary.
-
#failure_retention_period_in_days ⇒ Integer
The number of days to retain data about failed runs of this canary.
-
#name ⇒ String
The name of the canary that you want to update.
-
#run_config ⇒ Types::CanaryRunConfigInput
A structure that contains the timeout value that is used for each individual run of the canary.
-
#runtime_version ⇒ String
Specifies the runtime version to use for the canary.
-
#schedule ⇒ Types::CanaryScheduleInput
A structure that contains information about how often the canary is to run, and when these runs are to stop.
-
#success_retention_period_in_days ⇒ Integer
The number of days to retain data about successful runs of this canary.
-
#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.
Instance Attribute Details
#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.
#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:CreateLogStream
#failure_retention_period_in_days ⇒ Integer
The number of days to retain data about failed runs of this canary.
#name ⇒ String
The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
You cannot change the name of a canary that has already been created.
#run_config ⇒ Types::CanaryRunConfigInput
A structure that contains the timeout value that is used for each individual run of the canary.
#runtime_version ⇒ String
Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.
#schedule ⇒ Types::CanaryScheduleInput
A structure that contains information about how often the canary is to run, and when these runs are to stop.
#success_retention_period_in_days ⇒ Integer
The number of days to retain data about successful runs of this canary.
#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.