software.amazon.awscdk.services.resiliencehub

Class CfnApp

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

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.563Z")
 @Stability(value=Stable)
public class CfnApp
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ResilienceHub::App`.

Creates a Resilience Hub application. A Resilience Hub application is a collection of AWS resources structured to prevent and recover AWS application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more–up to five– AWS CloudFormation stacks, and an appropriate resiliency policy.

After you create a Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).

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.*;
 CfnApp cfnApp = CfnApp.Builder.create(this, "MyCfnApp")
         .appTemplateBody("appTemplateBody")
         .name("name")
         .resourceMappings(List.of(ResourceMappingProperty.builder()
                 .mappingType("mappingType")
                 .physicalResourceId(PhysicalResourceIdProperty.builder()
                         .identifier("identifier")
                         .type("type")
                         // the properties below are optional
                         .awsAccountId("awsAccountId")
                         .awsRegion("awsRegion")
                         .build())
                 // the properties below are optional
                 .logicalStackName("logicalStackName")
                 .resourceName("resourceName")
                 .terraformSourceName("terraformSourceName")
                 .build()))
         // the properties below are optional
         .appAssessmentSchedule("appAssessmentSchedule")
         .description("description")
         .resiliencyPolicyArn("resiliencyPolicyArn")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApp.Builder A fluent builder for CfnApp.
static interface	CfnApp.PhysicalResourceIdProperty Defines a physical resource identifier.
static interface	CfnApp.ResourceMappingProperty Defines a resource mapping.

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
	CfnApp(software.constructs.Construct scope, String id, CfnAppProps props) Create a new `AWS::ResilienceHub::App`.
protected	CfnApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApp(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAppAssessmentSchedule() `AWS::ResilienceHub::App.AppAssessmentSchedule`.
String	getAppTemplateBody() A string containing a full Resilience Hub app template body.
String	getAttrAppArn() The Amazon Resource Name (ARN) of the app.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The optional description for an app.
String	getName() The name for the application.
String	getResiliencyPolicyArn() The Amazon Resource Name (ARN) of the resiliency policy.
Object	getResourceMappings() An array of ResourceMapping objects.
TagManager	getTags() The tags assigned to the resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppAssessmentSchedule(String value) `AWS::ResilienceHub::App.AppAssessmentSchedule`.
void	setAppTemplateBody(String value) A string containing a full Resilience Hub app template body.
void	setDescription(String value) The optional description for an app.
void	setName(String value) The name for the application.
void	setResiliencyPolicyArn(String value) The Amazon Resource Name (ARN) of the resiliency policy.
void	setResourceMappings(IResolvable value) An array of ResourceMapping objects.
void	setResourceMappings(List<Object> value) An array of ResourceMapping objects.

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

CfnApp

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

CfnApp

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

CfnApp

@Stability(value=Stable)
public CfnApp(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @NotNull
                                       CfnAppProps props)

Create a new `AWS::ResilienceHub::App`.

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.

getAttrAppArn

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

The Amazon Resource Name (ARN) of the app.

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.

getAppTemplateBody

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

A string containing a full Resilience Hub app template body.

setAppTemplateBody

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

A string containing a full Resilience Hub app template body.

getName

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

The name for the application.

setName

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

The name for the application.

getResourceMappings

@Stability(value=Stable)
 @NotNull
public Object getResourceMappings()

An array of ResourceMapping objects.

setResourceMappings

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

An array of ResourceMapping objects.

setResourceMappings

@Stability(value=Stable)
public void setResourceMappings(@NotNull
                                                         List<Object> value)

An array of ResourceMapping objects.

getAppAssessmentSchedule

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

`AWS::ResilienceHub::App.AppAssessmentSchedule`.

setAppAssessmentSchedule

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

`AWS::ResilienceHub::App.AppAssessmentSchedule`.

getDescription

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

The optional description for an app.

setDescription

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

The optional description for an app.

getResiliencyPolicyArn

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

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

setResiliencyPolicyArn

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

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