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("software.amazon.awssdk:codegen") public final class CreateCanaryRequest extends SyntheticsRequest implements ToCopyableBuilder<CreateCanaryRequest.Builder,CreateCanaryRequest>

  • Method Details

    • 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 Amazon 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 Amazon 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. The name of the Amazon S3 bucket can't include a period (.).

      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. The name of the Amazon S3 bucket can't include a period (.).

    • 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 and environment variables.

      Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

      Returns:
      A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.

      Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

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

      This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

      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.

      This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

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

      This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

      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.

      This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

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

    • resourcesToReplicateTags

      public final List<ResourceToTag> resourcesToReplicateTags()

      To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

      If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourcesToReplicateTags() method.

      Returns:
      To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

      If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.

    • hasResourcesToReplicateTags

      public final boolean hasResourcesToReplicateTags()
      For responses, this returns true if the service returned a value for the ResourcesToReplicateTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • resourcesToReplicateTagsAsStrings

      public final List<String> resourcesToReplicateTagsAsStrings()

      To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

      If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourcesToReplicateTags() method.

      Returns:
      To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

      If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.

    • provisionedResourceCleanup

      public final ProvisionedResourceCleanupSetting provisionedResourceCleanup()

      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.

      If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

      If the service returns an enum value that is not available in the current SDK version, provisionedResourceCleanup will return ProvisionedResourceCleanupSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisionedResourceCleanupAsString().

      Returns:
      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.

      If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

      See Also:

    • provisionedResourceCleanupAsString

      public final String provisionedResourceCleanupAsString()

      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.

      If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

      If the service returns an enum value that is not available in the current SDK version, provisionedResourceCleanup will return ProvisionedResourceCleanupSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisionedResourceCleanupAsString().

      Returns:
      Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.

      If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.

      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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

      To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      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.

      To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

    • artifactConfig

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

      Returns:
      A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

    • toBuilder

      public CreateCanaryRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateCanaryRequest.Builder,CreateCanaryRequest>
      Specified by:
      toBuilder in class SyntheticsRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.