Uses of Class
com.amazonaws.services.synthetics.model.Canary

Packages that use Canary

Package	Description
com.amazonaws.services.synthetics.model

Uses of Canary in com.amazonaws.services.synthetics.model

Methods in com.amazonaws.services.synthetics.model that return Canary

Modifier and Type	Method and Description
Canary	Canary.addTagsEntry(String key, String value) Add a single Tags entry
Canary	Canary.clearTagsEntries() Removes all the entries added into Tags.
Canary	Canary.clone()
Canary	GetCanaryResult.getCanary() A strucure that contains the full information about the canary.
Canary	CreateCanaryResult.getCanary() The full details about the canary you have created.
Canary	Canary.withArtifactConfig(ArtifactConfigOutput artifactConfig) A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
Canary	Canary.withArtifactS3Location(String artifactS3Location) The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
Canary	Canary.withCode(CanaryCodeOutput code)
Canary	Canary.withEngineArn(String engineArn) The ARN of the Lambda function that is used as your canary's engine.
Canary	Canary.withExecutionRoleArn(String executionRoleArn) The ARN of the IAM role used to run the canary.
Canary	Canary.withFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays) The number of days to retain data about failed runs of this canary.
Canary	Canary.withId(String id) The unique ID of this canary.
Canary	Canary.withName(String name) The name of the canary.
Canary	Canary.withRunConfig(CanaryRunConfigOutput runConfig)
Canary	Canary.withRuntimeVersion(String runtimeVersion) Specifies the runtime version to use for the canary.
Canary	Canary.withSchedule(CanaryScheduleOutput schedule) A structure that contains information about how often the canary is to run, and when these runs are to stop.
Canary	Canary.withStatus(CanaryStatus status) A structure that contains information about the canary's status.
Canary	Canary.withSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays) The number of days to retain data about successful runs of this canary.
Canary	Canary.withTags(Map<String,String> tags) The list of key-value pairs that are associated with the canary.
Canary	Canary.withTimeline(CanaryTimeline timeline) A structure that contains information about when the canary was created, modified, and most recently run.
Canary	Canary.withVisualReference(VisualReferenceOutput visualReference) If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.
Canary	Canary.withVpcConfig(VpcConfigOutput vpcConfig)

Methods in com.amazonaws.services.synthetics.model that return types with arguments of type Canary

Modifier and Type	Method and Description
List<Canary>	DescribeCanariesResult.getCanaries() Returns an array.

Methods in com.amazonaws.services.synthetics.model with parameters of type Canary

Modifier and Type	Method and Description
void	GetCanaryResult.setCanary(Canary canary) A strucure that contains the full information about the canary.
void	CreateCanaryResult.setCanary(Canary canary) The full details about the canary you have created.
DescribeCanariesResult	DescribeCanariesResult.withCanaries(Canary... canaries) Returns an array.
GetCanaryResult	GetCanaryResult.withCanary(Canary canary) A strucure that contains the full information about the canary.
CreateCanaryResult	CreateCanaryResult.withCanary(Canary canary) The full details about the canary you have created.

Method parameters in com.amazonaws.services.synthetics.model with type arguments of type Canary

Modifier and Type	Method and Description
void	DescribeCanariesResult.setCanaries(Collection<Canary> canaries) Returns an array.
DescribeCanariesResult	DescribeCanariesResult.withCanaries(Collection<Canary> canaries) Returns an array.