@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateCanaryRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateCanaryRequest() |
Modifier and Type | Method and Description |
---|---|
CreateCanaryRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateCanaryRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateCanaryRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
ArtifactConfigInput |
getArtifactConfig()
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for
artifacts that the canary uploads to Amazon S3.
|
String |
getArtifactS3Location()
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
|
CanaryCodeInput |
getCode()
A structure that includes the entry point from which the canary should start running your script.
|
String |
getExecutionRoleArn()
The ARN of the IAM role to be used to run the canary.
|
Integer |
getFailureRetentionPeriodInDays()
The number of days to retain data about failed runs of this canary.
|
String |
getName()
The name for this canary.
|
CanaryRunConfigInput |
getRunConfig()
A structure that contains the configuration for individual canary runs, such as timeout value and environment
variables.
|
String |
getRuntimeVersion()
Specifies the runtime version to use for the canary.
|
CanaryScheduleInput |
getSchedule()
A structure that contains information about how often the canary is to run and when these test runs are to stop.
|
Integer |
getSuccessRetentionPeriodInDays()
The number of days to retain data about successful runs of this canary.
|
Map<String,String> |
getTags()
A list of key-value pairs to associate with the canary.
|
VpcConfigInput |
getVpcConfig()
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.
|
int |
hashCode() |
void |
setArtifactConfig(ArtifactConfigInput 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.
|
void |
setArtifactS3Location(String artifactS3Location)
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
|
void |
setCode(CanaryCodeInput code)
A structure that includes the entry point from which the canary should start running your script.
|
void |
setExecutionRoleArn(String executionRoleArn)
The ARN of the IAM role to be used to run the canary.
|
void |
setFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)
The number of days to retain data about failed runs of this canary.
|
void |
setName(String name)
The name for this canary.
|
void |
setRunConfig(CanaryRunConfigInput runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value and environment
variables.
|
void |
setRuntimeVersion(String runtimeVersion)
Specifies the runtime version to use for the canary.
|
void |
setSchedule(CanaryScheduleInput schedule)
A structure that contains information about how often the canary is to run and when these test runs are to stop.
|
void |
setSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays)
The number of days to retain data about successful runs of this canary.
|
void |
setTags(Map<String,String> tags)
A list of key-value pairs to associate with the canary.
|
void |
setVpcConfig(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.
|
String |
toString()
Returns a string representation of this object.
|
CreateCanaryRequest |
withArtifactConfig(ArtifactConfigInput 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.
|
CreateCanaryRequest |
withArtifactS3Location(String artifactS3Location)
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
|
CreateCanaryRequest |
withCode(CanaryCodeInput code)
A structure that includes the entry point from which the canary should start running your script.
|
CreateCanaryRequest |
withExecutionRoleArn(String executionRoleArn)
The ARN of the IAM role to be used to run the canary.
|
CreateCanaryRequest |
withFailureRetentionPeriodInDays(Integer failureRetentionPeriodInDays)
The number of days to retain data about failed runs of this canary.
|
CreateCanaryRequest |
withName(String name)
The name for this canary.
|
CreateCanaryRequest |
withRunConfig(CanaryRunConfigInput runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value and environment
variables.
|
CreateCanaryRequest |
withRuntimeVersion(String runtimeVersion)
Specifies the runtime version to use for the canary.
|
CreateCanaryRequest |
withSchedule(CanaryScheduleInput schedule)
A structure that contains information about how often the canary is to run and when these test runs are to stop.
|
CreateCanaryRequest |
withSuccessRetentionPeriodInDays(Integer successRetentionPeriodInDays)
The number of days to retain data about successful runs of this canary.
|
CreateCanaryRequest |
withTags(Map<String,String> tags)
A list of key-value pairs to associate with the canary.
|
CreateCanaryRequest |
withVpcConfig(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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setName(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.
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.
public String getName()
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.
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.
public CreateCanaryRequest withName(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.
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.
public void setCode(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.
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.public CanaryCodeInput getCode()
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.
public CreateCanaryRequest withCode(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.
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.public void setArtifactS3Location(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. The name of the S3 bucket can't include a period (.).
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. The name of the S3 bucket can't include a period (.).public String getArtifactS3Location()
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. The name of the S3 bucket can't include a period (.).
public CreateCanaryRequest withArtifactS3Location(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. The name of the S3 bucket can't include a period (.).
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. The name of the S3 bucket can't include a period (.).public void setExecutionRoleArn(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
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
public String getExecutionRoleArn()
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
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
public CreateCanaryRequest withExecutionRoleArn(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
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
public void setSchedule(CanaryScheduleInput schedule)
A structure that contains information about how often the canary is to run and when these test runs are to stop.
schedule
- A structure that contains information about how often the canary is to run and when these test runs are to
stop.public CanaryScheduleInput getSchedule()
A structure that contains information about how often the canary is to run and when these test runs are to stop.
public CreateCanaryRequest withSchedule(CanaryScheduleInput schedule)
A structure that contains information about how often the canary is to run and when these test runs are to stop.
schedule
- A structure that contains information about how often the canary is to run and when these test runs are to
stop.public void setRunConfig(CanaryRunConfigInput runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
runConfig
- A structure that contains the configuration for individual canary runs, such as timeout value and
environment variables. The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
public CanaryRunConfigInput getRunConfig()
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
public CreateCanaryRequest withRunConfig(CanaryRunConfigInput runConfig)
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
runConfig
- A structure that contains the configuration for individual canary runs, such as timeout value and
environment variables. The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
public void setSuccessRetentionPeriodInDays(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.
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.public Integer getSuccessRetentionPeriodInDays()
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.
public CreateCanaryRequest withSuccessRetentionPeriodInDays(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.
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.public void setFailureRetentionPeriodInDays(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.
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.public Integer getFailureRetentionPeriodInDays()
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.
public CreateCanaryRequest withFailureRetentionPeriodInDays(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.
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.public void setRuntimeVersion(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.
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.public String getRuntimeVersion()
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.
public CreateCanaryRequest withRuntimeVersion(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.
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.public void setVpcConfig(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.
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.public VpcConfigInput getVpcConfig()
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.
public CreateCanaryRequest withVpcConfig(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.
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.public Map<String,String> getTags()
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.
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.
public void setTags(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.
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.
public CreateCanaryRequest withTags(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.
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.
public CreateCanaryRequest addTagsEntry(String key, String value)
public CreateCanaryRequest clearTagsEntries()
public void setArtifactConfig(ArtifactConfigInput 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.
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.public ArtifactConfigInput getArtifactConfig()
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
public CreateCanaryRequest withArtifactConfig(ArtifactConfigInput 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.
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.public String toString()
toString
in class Object
Object.toString()
public CreateCanaryRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()