UpdateCanaryRequest Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    code

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.

Declaration

Swift

public let code: CanaryCodeInput?


                    
                    
                    executionRoleArn

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

Declaration

Swift

public let executionRoleArn: String?


                    
                    
                    failureRetentionPeriodInDays

The number of days to retain data about failed runs of this canary.

Declaration

Swift

public let failureRetentionPeriodInDays: Int?


                    
                    
                    name

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.

Declaration

Swift

public let name: String


                    
                    
                    runConfig

A structure that contains the timeout value that is used for each individual run of the canary.

Declaration

Swift

public let runConfig: CanaryRunConfigInput?


                    
                    
                    runtimeVersion

Specifies the runtime version to use for the canary. Currently, the only valid value is syn-1.0. For more information about runtime versions, see Canary Runtime Versions.

Declaration

Swift

public let runtimeVersion: String?


                    
                    
                    schedule

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

Declaration

Swift

public let schedule: CanaryScheduleInput?


                    
                    
                    successRetentionPeriodInDays

The number of days to retain data about successful runs of this canary.

Declaration

Swift

public let successRetentionPeriodInDays: Int?


                    
                    
                    vpcConfig

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.

Declaration

Swift

public let vpcConfig: VpcConfigInput?


                    
                    
                    init(code:executionRoleArn:failureRetentionPeriodInDays:name:runConfig:runtimeVersion:schedule:successRetentionPeriodInDays:vpcConfig:)

Undocumented

Declaration

Swift

public init(code: CanaryCodeInput? = nil, executionRoleArn: String? = nil, failureRetentionPeriodInDays: Int? = nil, name: String, runConfig: CanaryRunConfigInput? = nil, runtimeVersion: String? = nil, schedule: CanaryScheduleInput? = nil, successRetentionPeriodInDays: Int? = nil, vpcConfig: VpcConfigInput? = nil)


                    
                    
                    validate(name:)

Declaration

Swift

public func validate(name: String) throws