Package software.amazon.awscdk.services.route53recoveryreadiness

Class CfnReadinessCheck

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.route53recoveryreadiness.CfnReadinessCheck
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.035Z") @Stability(Stable) public class CfnReadinessCheck extends CfnResource implements IInspectable
A CloudFormation AWS::Route53RecoveryReadiness::ReadinessCheck.

Creates a readiness check in Amazon Route 53 Application Recovery Controller. A readiness check continually monitors a resource set in your application, such as a set of Amazon Aurora instances, that Route 53 ARC is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.

Every resource type has a set of rules associated with it that Route 53 ARC uses to audit resources for readiness. For more information, see Readiness rules descriptions in the Amazon Route 53 Application Recovery Controller Developer Guide.

Route 53 ARC Readiness supports us-east-1 and us-west-2 AWS Regions only.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.route53recoveryreadiness.*;
 CfnReadinessCheck cfnReadinessCheck = CfnReadinessCheck.Builder.create(this, "MyCfnReadinessCheck")
         .readinessCheckName("readinessCheckName")
         .resourceSetName("resourceSetName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnReadinessCheck

      protected CfnReadinessCheck(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnReadinessCheck

      protected CfnReadinessCheck(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnReadinessCheck

      @Stability(Stable) public CfnReadinessCheck(@NotNull Construct scope, @NotNull String id, @Nullable CfnReadinessCheckProps props)
      Create a new AWS::Route53RecoveryReadiness::ReadinessCheck.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnReadinessCheck

      @Stability(Stable) public CfnReadinessCheck(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::Route53RecoveryReadiness::ReadinessCheck.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrReadinessCheckArn

      @Stability(Stable) @NotNull public String getAttrReadinessCheckArn()
      The Amazon Resource Name (ARN) of the readiness check.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A collection of tags associated with a resource.

    • getReadinessCheckName

      @Stability(Stable) @Nullable public String getReadinessCheckName()
      The name of the readiness check to create.

    • setReadinessCheckName

      @Stability(Stable) public void setReadinessCheckName(@Nullable String value)
      The name of the readiness check to create.

    • getResourceSetName

      @Stability(Stable) @Nullable public String getResourceSetName()
      The name of the resource set to check.

    • setResourceSetName

      @Stability(Stable) public void setResourceSetName(@Nullable String value)
      The name of the resource set to check.