Class: Aws::Synthetics::Types::UpdateCanaryRequest

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 UpdateCanaryRequest data as a 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"],
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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



1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1312

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config)
  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:CreateLogStream

Returns:

  • (String)


1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1312

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

#failure_retention_period_in_daysInteger

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

Returns:

  • (Integer)


1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1312

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

#nameString

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.

Returns:

  • (String)


1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1312

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

#run_configTypes::CanaryRunConfigInput

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



1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1312

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

#runtime_versionString

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.

Returns:

  • (String)


1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1312

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

#scheduleTypes::CanaryScheduleInput

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



1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1312

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

#success_retention_period_in_daysInteger

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

Returns:

  • (Integer)


1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1312

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config)
  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.



1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1312

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