class CfnApp (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ResilienceHub.CfnApp |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsresiliencehub#CfnApp |
![]() | software.amazon.awscdk.services.resiliencehub.CfnApp |
![]() | aws_cdk.aws_resiliencehub.CfnApp |
![]() | aws-cdk-lib » aws_resiliencehub » CfnApp |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Creates an AWS Resilience Hub application.
An AWS Resilience Hub application is a collection of AWS resources structured to prevent and recover AWS application disruptions. To describe a AWS Resilience Hub application, you provide an application name, resources from one or more AWS CloudFormation stacks, AWS Resource Groups , Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas .
After you create an AWS 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).
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_resiliencehub as resiliencehub } from 'aws-cdk-lib';
const cfnApp = new resiliencehub.CfnApp(this, 'MyCfnApp', {
appTemplateBody: 'appTemplateBody',
name: 'name',
resourceMappings: [{
mappingType: 'mappingType',
physicalResourceId: {
identifier: 'identifier',
type: 'type',
// the properties below are optional
awsAccountId: 'awsAccountId',
awsRegion: 'awsRegion',
},
// the properties below are optional
eksSourceName: 'eksSourceName',
logicalStackName: 'logicalStackName',
resourceName: 'resourceName',
terraformSourceName: 'terraformSourceName',
}],
// the properties below are optional
appAssessmentSchedule: 'appAssessmentSchedule',
description: 'description',
eventSubscriptions: [{
eventType: 'eventType',
name: 'name',
// the properties below are optional
snsTopicArn: 'snsTopicArn',
}],
permissionModel: {
type: 'type',
// the properties below are optional
crossAccountRoleArns: ['crossAccountRoleArns'],
invokerRoleName: 'invokerRoleName',
},
resiliencyPolicyArn: 'resiliencyPolicyArn',
tags: {
tagsKey: 'tags',
},
});
Initializer
new CfnApp(scope: Construct, id: string, props: CfnAppProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.App Props
Construct Props
Name | Type | Description |
---|---|---|
app | string | A JSON string that provides information about your application structure. |
name | string | Name for the application. |
resource | IResolvable | IResolvable | Resource [] | An array of ResourceMapping objects. |
app | string | Assessment execution schedule with 'Daily' or 'Disabled' values. |
description? | string | Optional description for an application. |
event | IResolvable | IResolvable | Event [] | The list of events you would like to subscribe and get notification for. |
permission | IResolvable | Permission | Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment. |
resiliency | string | The Amazon Resource Name (ARN) of the resiliency policy. |
tags? | { [string]: string } | Tags assigned to the resource. |
appTemplateBody
Type:
string
A JSON string that provides information about your application structure.
To learn more about the appTemplateBody
template, see the sample template in Sample appTemplateBody template .
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
Identifier of the resource.
Type: String
logicalStackName
Name of the AWS CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
Name of the resource group this resource belongs to.
Type: String
terraformSourceName
Name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
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
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
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
Name of the AWS CloudFormation stack this resource belongs to.
Type: String
resourceGroupName
Name of the resource group this resource belongs to.
Type: String
terraformSourceName
Name of the Terraform S3 state file this resource belongs to.
Type: String
eksSourceName
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>"}]}]"
name
Type:
string
Name for the application.
resourceMappings
Type:
IResolvable
|
IResolvable
|
Resource
[]
An array of ResourceMapping
objects.
appAssessmentSchedule?
Type:
string
(optional)
Assessment execution schedule with 'Daily' or 'Disabled' values.
description?
Type:
string
(optional)
Optional description for an application.
eventSubscriptions?
Type:
IResolvable
|
IResolvable
|
Event
[]
(optional)
The list of events you would like to subscribe and get notification for.
Currently, AWS Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.
permissionModel?
Type:
IResolvable
|
Permission
(optional)
Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.
resiliencyPolicyArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the resiliency policy.
tags?
Type:
{ [string]: string }
(optional)
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.
Properties
Name | Type | Description |
---|---|---|
app | string | A JSON string that provides information about your application structure. |
attr | string | The Amazon Resource Name (ARN) of the applcation. |
attr | string | Indicates if compliance drifts (deviations) were detected while running an assessment for your application. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
name | string | Name for the application. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
resource | IResolvable | IResolvable | Resource [] | An array of ResourceMapping objects. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
app | string | Assessment execution schedule with 'Daily' or 'Disabled' values. |
description? | string | Optional description for an application. |
event | IResolvable | IResolvable | Event [] | The list of events you would like to subscribe and get notification for. |
permission | IResolvable | Permission | Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment. |
resiliency | string | The Amazon Resource Name (ARN) of the resiliency policy. |
tags | { [string]: string } | Tags assigned to the resource. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
appTemplateBody
Type:
string
A JSON string that provides information about your application structure.
attrAppArn
Type:
string
The Amazon Resource Name (ARN) of the applcation.
attrDriftStatus
Type:
string
Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
name
Type:
string
Name for the application.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
resourceMappings
Type:
IResolvable
|
IResolvable
|
Resource
[]
An array of ResourceMapping
objects.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
appAssessmentSchedule?
Type:
string
(optional)
Assessment execution schedule with 'Daily' or 'Disabled' values.
description?
Type:
string
(optional)
Optional description for an application.
eventSubscriptions?
Type:
IResolvable
|
IResolvable
|
Event
[]
(optional)
The list of events you would like to subscribe and get notification for.
permissionModel?
Type:
IResolvable
|
Permission
(optional)
Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.
resiliencyPolicyArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the resiliency policy.
tagsRaw?
Type:
{ [string]: string }
(optional)
Tags assigned to the resource.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }