Class StartCanaryDryRunRequest

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.StartCanaryDryRunRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartCanaryDryRunRequest.Builder,StartCanaryDryRunRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartCanaryDryRunRequest extends SyntheticsRequest implements ToCopyableBuilder<StartCanaryDryRunRequest.Builder,StartCanaryDryRunRequest>

  • Method Details

    • name

      public final String name()

      The name of the canary that you want to dry run. To find canary names, use DescribeCanaries.

      Returns:
      The name of the canary that you want to dry run. To find canary names, use DescribeCanaries.

    • code

      public final CanaryCodeInput code()
      Returns the value of the Code property for this object.
      Returns:
      The value of the Code property for this object.

    • runtimeVersion

      public final String runtimeVersion()

      Specifies the runtime version to use for the canary. For a list of valid runtime versions and for 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 for more information about runtime versions, see Canary Runtime Versions.

    • runConfig

      public final CanaryRunConfigInput runConfig()
      Returns the value of the RunConfig property for this object.
      Returns:
      The value of the RunConfig property for this object.

    • vpcConfig

      public final VpcConfigInput vpcConfig()
      Returns the value of the VpcConfig property for this object.
      Returns:
      The value of the VpcConfig property for this object.

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

      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:

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

    • visualReference

      public final VisualReferenceInput visualReference()
      Returns the value of the VisualReference property for this object.
      Returns:
      The value of the VisualReference property for this object.

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

    • artifactConfig

      public final ArtifactConfigInput artifactConfig()
      Returns the value of the ArtifactConfig property for this object.
      Returns:
      The value of the ArtifactConfig property for this object.

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

    • hasBrowserConfigs

      public final boolean hasBrowserConfigs()
      For responses, this returns true if the service returned a value for the BrowserConfigs 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.

    • browserConfigs

      public final List<BrowserConfig> browserConfigs()

      A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

      If not specified, browserConfigs defaults to Chrome.

      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 hasBrowserConfigs() method.

      Returns:
      A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

      If not specified, browserConfigs defaults to Chrome.

    • hasVisualReferences

      public final boolean hasVisualReferences()
      For responses, this returns true if the service returned a value for the VisualReferences 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.

    • visualReferences

      public final List<VisualReferenceInput> visualReferences()

      A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.

      syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

      Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences for consistency and future compatibility.

      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 hasVisualReferences() method.

      Returns:
      A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.

      syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

      Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences for consistency and future compatibility.

    • toBuilder

      public StartCanaryDryRunRequest.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<StartCanaryDryRunRequest.Builder,StartCanaryDryRunRequest>
      Specified by:
      toBuilder in class SyntheticsRequest
      Returns:
      a builder for type T

    • builder

      public static StartCanaryDryRunRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartCanaryDryRunRequest.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.