software.amazon.awssdk.services.synthetics.model

Class CreateCanaryRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.synthetics.model.SyntheticsRequest

software.amazon.awssdk.services.synthetics.model.CreateCanaryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCanaryRequest.Builder,CreateCanaryRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateCanaryRequest
extends SyntheticsRequest
implements ToCopyableBuilder<CreateCanaryRequest.Builder,CreateCanaryRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCanaryRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	artifactS3Location() The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
static CreateCanaryRequest.Builder	builder()
CanaryCodeInput	code() A structure that includes the entry point from which the canary should start running your script.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleArn() The ARN of the IAM role to be used to run the canary.
Integer	failureRetentionPeriodInDays() The number of days to retain data about failed runs of this canary.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() The name for this canary.
CanaryRunConfigInput	runConfig() A structure that contains the configuration for individual canary runs, such as timeout value.
String	runtimeVersion() Specifies the runtime version to use for the canary.
CanaryScheduleInput	schedule() A structure that contains information about how often the canary is to run and when these test runs are to stop.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCanaryRequest.Builder>	serializableBuilderClass()
Integer	successRetentionPeriodInDays() The number of days to retain data about successful runs of this canary.
Map<String,String>	tags() A list of key-value pairs to associate with the canary.
CreateCanaryRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VpcConfigInput	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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

Returns:

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

code

public final CanaryCodeInput 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.

Returns:

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.

artifactS3Location

public final String artifactS3Location()

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files.

Returns:

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files.

executionRoleArn

public final String 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:PutLogEvents

Returns:

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:PutLogEvents

schedule

public final CanaryScheduleInput schedule()

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

Returns:

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

runConfig

public final CanaryRunConfigInput runConfig()

A structure that contains the configuration for individual canary runs, such as timeout value.

Returns:

A structure that contains the configuration for individual canary runs, such as timeout value.

successRetentionPeriodInDays

public final Integer successRetentionPeriodInDays()

The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Returns:

The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

failureRetentionPeriodInDays

public final Integer failureRetentionPeriodInDays()

The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

Returns:

The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

runtimeVersion

public final String runtimeVersion()

Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions.

Returns:

Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions.

vpcConfig

public final VpcConfigInput 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.

Returns:

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.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

toBuilder

public CreateCanaryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCanaryRequest.Builder,CreateCanaryRequest>

Specified by:

toBuilder in class SyntheticsRequest

builder

public static CreateCanaryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCanaryRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo