Class: Aws::Synthetics::Types::Canary

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

Overview

This structure contains all information about one canary in your account.

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 runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Returns:

  • (String)


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#codeTypes::CanaryCodeOutput

This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#engine_arnString

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

Returns:

  • (String)


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arnString

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

Returns:

  • (String)


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :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.

Returns:

  • (Integer)


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The unique ID of this canary.

Returns:

  • (String)


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the canary.

Returns:

  • (String)


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#run_configTypes::CanaryRunConfigOutput

A structure that contains information about a canary run.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_versionString

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

Returns:

  • (String)


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::CanaryScheduleOutput

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#statusTypes::CanaryStatus

A structure that contains information about the canary's status.

Returns:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :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.

Returns:

  • (Integer)


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The list of key-value pairs that are associated with the canary.

Returns:

  • (Hash<String,String>)


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#timelineTypes::CanaryTimeline

A structure that contains information about when the canary was created, modified, and most recently run.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configTypes::VpcConfigOutput

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 104

class Canary < Struct.new(
  :id,
  :name,
  :code,
  :execution_role_arn,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :status,
  :timeline,
  :artifact_s3_location,
  :engine_arn,
  :runtime_version,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end