software.amazon.awscdk.services.resiliencehub

Class CfnResiliencyPolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.resiliencehub.CfnResiliencyPolicy

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.565Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnResiliencyPolicy.Builder A fluent builder for CfnResiliencyPolicy.
static interface	CfnResiliencyPolicy.FailurePolicyProperty Defines a failure policy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResiliencyPolicy(software.constructs.Construct scope, String id, CfnResiliencyPolicyProps props) Create a new `AWS::ResilienceHub::ResiliencyPolicy`.
protected	CfnResiliencyPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResiliencyPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrPolicyArn() The Amazon Resource Name (ARN) of the resiliency policy.
protected Map<String,Object>	getCfnProperties()
String	getDataLocationConstraint() Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
Object	getPolicy() The resiliency policy.
String	getPolicyDescription() The description for the policy.
String	getPolicyName() The name of the policy.
TagManager	getTags() The tags assigned to the resource.
String	getTier() The tier for this resiliency policy, ranging from the highest severity ( `MissionCritical` ) to lowest ( `NonCritical` ).
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataLocationConstraint(String value) Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
void	setPolicy(IResolvable value) The resiliency policy.
void	setPolicy(Map<String,Object> value) The resiliency policy.
void	setPolicyDescription(String value) The description for the policy.
void	setPolicyName(String value) The name of the policy.
void	setTier(String value) The tier for this resiliency policy, ranging from the highest severity ( `MissionCritical` ) to lowest ( `NonCritical` ).

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnResiliencyPolicy

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

CfnResiliencyPolicy

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

CfnResiliencyPolicy

@Stability(value=Stable)
public CfnResiliencyPolicy(@NotNull
                                                    software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrPolicyArn()

The Amazon Resource Name (ARN) of the resiliency policy.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=Stable)
 @NotNull
public Object getPolicy()

The resiliency policy.

setPolicy

@Stability(value=Stable)
public void setPolicy(@NotNull
                                               IResolvable value)

The resiliency policy.

setPolicy

@Stability(value=Stable)
public void setPolicy(@NotNull
                                               Map<String,Object> value)

The resiliency policy.

getPolicyName

@Stability(value=Stable)
 @NotNull
public String getPolicyName()

The name of the policy.

setPolicyName

@Stability(value=Stable)
public void setPolicyName(@NotNull
                                                   String value)

The name of the policy.

getTier

@Stability(value=Stable)
 @NotNull
public String getTier()

The tier for this resiliency policy, ranging from the highest severity ( `MissionCritical` ) to lowest ( `NonCritical` ).

setTier

@Stability(value=Stable)
public void setTier(@NotNull
                                             String value)

The tier for this resiliency policy, ranging from the highest severity ( `MissionCritical` ) to lowest ( `NonCritical` ).

getDataLocationConstraint

@Stability(value=Stable)
 @Nullable
public String getDataLocationConstraint()

Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

setDataLocationConstraint

@Stability(value=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(value=Stable)
 @Nullable
public String getPolicyDescription()

The description for the policy.

setPolicyDescription

@Stability(value=Stable)
public void setPolicyDescription(@Nullable
                                                          String value)

The description for the policy.