Package software.amazon.awscdk.services.resiliencehub

Class CfnResiliencyPolicy

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.resiliencehub.CfnResiliencyPolicy
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:34.967Z") @Stability(Stable) public class CfnResiliencyPolicy extends CfnResource implements IInspectable
A CloudFormation AWS::ResilienceHub::ResiliencyPolicy.

Defines a resiliency policy.

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.resiliencehub.*;
 CfnResiliencyPolicy cfnResiliencyPolicy = CfnResiliencyPolicy.Builder.create(this, "MyCfnResiliencyPolicy")
         .policy(Map.of(
                 "policyKey", FailurePolicyProperty.builder()
                         .rpoInSecs(123)
                         .rtoInSecs(123)
                         .build()))
         .policyName("policyName")
         .tier("tier")
         // the properties below are optional
         .dataLocationConstraint("dataLocationConstraint")
         .policyDescription("policyDescription")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .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

    • CfnResiliencyPolicy

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

    • CfnResiliencyPolicy

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

    • CfnResiliencyPolicy

      @Stability(Stable) public CfnResiliencyPolicy(@NotNull Construct scope, @NotNull String id, @NotNull CfnResiliencyPolicyProps props)
      Create a new AWS::ResilienceHub::ResiliencyPolicy.

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

    • getAttrPolicyArn

      @Stability(Stable) @NotNull public String getAttrPolicyArn()
      The Amazon Resource Name (ARN) of the resiliency policy.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags assigned to the resource.

      A tag is a label that you assign to an AWS resource. Each tag consists of a key/value pair.

    • getPolicy

      @Stability(Stable) @NotNull public Object getPolicy()
      The resiliency policy.

    • setPolicy

      @Stability(Stable) public void setPolicy(@NotNull IResolvable value)
      The resiliency policy.

    • setPolicy

      @Stability(Stable) public void setPolicy(@NotNull Map<String,Object> value)
      The resiliency policy.

    • getPolicyName

      @Stability(Stable) @NotNull public String getPolicyName()
      The name of the policy.

    • setPolicyName

      @Stability(Stable) public void setPolicyName(@NotNull String value)
      The name of the policy.

    • getTier

      @Stability(Stable) @NotNull public String getTier()
      The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

    • setTier

      @Stability(Stable) public void setTier(@NotNull String value)
      The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).

    • getDataLocationConstraint

      @Stability(Stable) @Nullable public String getDataLocationConstraint()
      Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

    • setDataLocationConstraint

      @Stability(Stable) public void setDataLocationConstraint(@Nullable String value)
      Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

    • getPolicyDescription

      @Stability(Stable) @Nullable public String getPolicyDescription()
      The description for the policy.

    • setPolicyDescription

      @Stability(Stable) public void setPolicyDescription(@Nullable String value)
      The description for the policy.