Package software.amazon.awscdk.services.resiliencehub

Interface CfnAppProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:34.951Z")
@Stability(Stable)
public interface CfnAppProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApp.

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.*;
 CfnAppProps cfnAppProps = CfnAppProps.builder()
         .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
                 .eksSourceName("eksSourceName")
                 .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	Interface	Description
static final class	CfnAppProps.Builder	A builder for CfnAppProps
static final class	CfnAppProps.Jsii$Proxy	An implementation for CfnAppProps

Method Summary

Modifier and Type	Method	Description
static CfnAppProps.Builder	builder()
default String	getAppAssessmentSchedule()	Assessment execution schedule with 'Daily' or 'Disabled' values.
String	getAppTemplateBody()	A JSON string that provides information about your application structure.
default String	getDescription()	The optional description for an app.
String	getName()	The name for the application.
default String	getResiliencyPolicyArn()	The Amazon Resource Name (ARN) of the resiliency policy.
Object	getResourceMappings()	An array of ResourceMapping objects.
default Map<String,String>	getTags()	The tags assigned to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppTemplateBody

@Stability(Stable)
@NotNull
String getAppTemplateBody()

A JSON string that provides information about your application structure.

To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

The appTemplateBody JSON string has the following structure:

• resources

The list of logical resources that needs to be included in the AWS Resilience Hub application.

Type: Array

Don't add the resources that you want to exclude.

Each resources array item includes the following fields:

• logicalResourceId

The logical identifier of the resource.

Type: Object

Each logicalResourceId object includes the following fields:

• identifier

The identifier of the resource.

Type: String

• logicalStackName

The name of the AWS CloudFormation stack this resource belongs to.

Type: String

• resourceGroupName

The name of the resource group this resource belongs to.

Type: String

• terraformSourceName

The name of the Terraform S3 state file this resource belongs to.

Type: String

• eksSourceName

The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

This parameter accepts values in "eks-cluster/namespace" format.

Type: String

• type

The type of resource.

Type: string

• name

The name of the resource.

Type: String

• additionalInfo

Additional configuration parameters for an AWS Resilience Hub application. If you want to implement additionalInfo through the AWS Resilience Hub console rather than using an API call, see Configure the application configuration parameters .

Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

• appComponents

The list of Application Components (AppComponent) that this resource belongs to. If an AppComponent is not part of the AWS Resilience Hub application, it will be added.

Type: Array

Each appComponents array item includes the following fields:

• name

The name of the AppComponent.

Type: String

• type

The type of AppComponent. For more information about the types of AppComponent, see Grouping resources in an AppComponent .

Type: String

• resourceNames

The list of included resources that are assigned to the AppComponent.

Type: Array of strings

• additionalInfo

Additional configuration parameters for an AWS Resilience Hub application. If you want to implement additionalInfo through the AWS Resilience Hub console rather than using an API call, see Configure the application configuration parameters .

Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

• excludedResources

The list of logical resource identifiers to be excluded from the application.

Type: Array

Don't add the resources that you want to include.

Each excludedResources array item includes the following fields:

• logicalResourceIds

The logical identifier of the resource.

Type: Object

You can configure only one of the following fields:

• logicalStackName
• resourceGroupName
• terraformSourceName
• eksSourceName

Each logicalResourceIds object includes the following fields:

• identifier

The identifier of the resource.

Type: String

• logicalStackName

The name of the AWS CloudFormation stack this resource belongs to.

Type: String

• resourceGroupName

The name of the resource group this resource belongs to.

Type: String

• terraformSourceName

The name of the Terraform S3 state file this resource belongs to.

Type: String

• eksSourceName

The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

This parameter accepts values in "eks-cluster/namespace" format.

Type: String

• version

The AWS Resilience Hub application version.

• additionalInfo

Additional configuration parameters for an AWS Resilience Hub application. If you want to implement additionalInfo through the AWS Resilience Hub console rather than using an API call, see Configure the application configuration parameters .

Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

Key: "failover-regions"

Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

getName

@Stability(Stable)
@NotNull
String getName()

The name for the application.

getResourceMappings

@Stability(Stable)
@NotNull
Object getResourceMappings()

An array of ResourceMapping objects.

getAppAssessmentSchedule

@Stability(Stable)
@Nullable
default String getAppAssessmentSchedule()

Assessment execution schedule with 'Daily' or 'Disabled' values.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The optional description for an app.

getResiliencyPolicyArn

@Stability(Stable)
@Nullable
default String getResiliencyPolicyArn()

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> 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.

builder

@Stability(Stable)
static CfnAppProps.Builder builder()

Returns:

a CfnAppProps.Builder of CfnAppProps