CfnApp
- class aws_cdk.aws_resiliencehub.CfnApp(scope, id, *, app_template_body, name, resource_mappings, app_assessment_schedule=None, description=None, resiliency_policy_arn=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::ResilienceHub::App
.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).
- CloudformationResource:
AWS::ResilienceHub::App
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_resiliencehub as resiliencehub cfn_app = resiliencehub.CfnApp(self, "MyCfnApp", app_template_body="appTemplateBody", name="name", resource_mappings=[resiliencehub.CfnApp.ResourceMappingProperty( mapping_type="mappingType", physical_resource_id=resiliencehub.CfnApp.PhysicalResourceIdProperty( identifier="identifier", type="type", # the properties below are optional aws_account_id="awsAccountId", aws_region="awsRegion" ), # the properties below are optional eks_source_name="eksSourceName", logical_stack_name="logicalStackName", resource_name="resourceName", terraform_source_name="terraformSourceName" )], # the properties below are optional app_assessment_schedule="appAssessmentSchedule", description="description", resiliency_policy_arn="resiliencyPolicyArn", tags={ "tags_key": "tags" } )
Create a new
AWS::ResilienceHub::App
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
app_template_body (
str
) –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. TheappTemplateBody
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 .. epigraph:: Don’t add the resources that you want to exclude. Eachresources
array item includes the following fields: - ``logicalResourceId`` The logical identifier of the resource. Type: Object EachlogicalResourceId
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. .. epigraph:: 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 implementadditionalInfo
through the AWS Resilience Hub console rather than using an API call, see Configure the application configuration parameters . .. epigraph:: 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 EachappComponents
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 implementadditionalInfo
through the AWS Resilience Hub console rather than using an API call, see Configure the application configuration parameters . .. epigraph:: 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 .. epigraph:: Don’t add the resources that you want to include. EachexcludedResources
array item includes the following fields: - ``logicalResourceIds`` The logical identifier of the resource. Type: Object .. epigraph:: You can configure only one of the following fields: -logicalStackName
-resourceGroupName
-terraformSourceName
-eksSourceName
EachlogicalResourceIds
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. .. epigraph:: 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 implementadditionalInfo
through the AWS Resilience Hub console rather than using an API call, see Configure the application configuration parameters . .. epigraph:: 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 (
str
) – The name for the application.resource_mappings (
Union
[IResolvable
,Sequence
[Union
[ResourceMappingProperty
,Dict
[str
,Any
],IResolvable
]]]) – An array of ResourceMapping objects.app_assessment_schedule (
Optional
[str
]) – Assessment execution schedule with ‘Daily’ or ‘Disabled’ values.description (
Optional
[str
]) – The optional description for an app.resiliency_policy_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the resiliency policy.tags (
Optional
[Mapping
[str
,str
]]) – 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.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
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.
- Parameters:
target (
CfnResource
)- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
)value (
Any
)
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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
).- Parameters:
policy (
Optional
[RemovalPolicy
])apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
)- See:
- Return type:
Any
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)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::ResilienceHub::App'
- app_assessment_schedule
Assessment execution schedule with ‘Daily’ or ‘Disabled’ values.
- app_template_body
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 .. epigraph:
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. .. epigraph:
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 . .. epigraph: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 . .. epigraph: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 .. epigraph:
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 .. epigraph:
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. .. epigraph:
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 . .. epigraph: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>"}]}]"``
- attr_app_arn
The Amazon Resource Name (ARN) of the app.
- CloudformationAttribute:
AppArn
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
The optional description for an app.
- logical_id
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)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name for the application.
- node
The construct tree node associated with this construct.
- ref
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 })
.
- resiliency_policy_arn
The Amazon Resource Name (ARN) of the resiliency policy.
- resource_mappings
An array of ResourceMapping objects.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
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.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
)- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
)- Return type:
bool
PhysicalResourceIdProperty
- class CfnApp.PhysicalResourceIdProperty(*, identifier, type, aws_account_id=None, aws_region=None)
Bases:
object
Defines a physical resource identifier.
- Parameters:
identifier (
str
) – The identifier of the physical resource.type (
str
) – Specifies the type of physical resource identifier. - Arn - The resource identifier is an Amazon Resource Name (ARN) . - Native - The resource identifier is an AWS Resilience Hub -native identifier.aws_account_id (
Optional
[str
]) – The AWS account that owns the physical resource.aws_region (
Optional
[str
]) – The AWS Region that the physical resource is located in.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_resiliencehub as resiliencehub physical_resource_id_property = resiliencehub.CfnApp.PhysicalResourceIdProperty( identifier="identifier", type="type", # the properties below are optional aws_account_id="awsAccountId", aws_region="awsRegion" )
Attributes
- aws_account_id
The AWS account that owns the physical resource.
- aws_region
The AWS Region that the physical resource is located in.
- identifier
The identifier of the physical resource.
- type
Specifies the type of physical resource identifier.
Arn - The resource identifier is an Amazon Resource Name (ARN) .
Native - The resource identifier is an AWS Resilience Hub -native identifier.
ResourceMappingProperty
- class CfnApp.ResourceMappingProperty(*, mapping_type, physical_resource_id, eks_source_name=None, logical_stack_name=None, resource_name=None, terraform_source_name=None)
Bases:
object
Defines a resource mapping.
- Parameters:
mapping_type (
str
) – Specifies the type of resource mapping. Valid Values: CfnStack | Resource | AppRegistryApp | ResourceGroup | Terraform - AppRegistryApp - The resource is mapped to another application. The name of the application is contained in theappRegistryAppName
property. - CfnStack - The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in thelogicalStackName
property. - Resource - The resource is mapped to another resource. The name of the resource is contained in theresourceName
property. - ResourceGroup - The resource is mapped to a resource group. The name of the resource group is contained in theresourceGroupName
property.physical_resource_id (
Union
[IResolvable
,PhysicalResourceIdProperty
,Dict
[str
,Any
]]) – The identifier of this resource.eks_source_name (
Optional
[str
]) –CfnApp.ResourceMappingProperty.EksSourceName
.logical_stack_name (
Optional
[str
]) – The name of the CloudFormation stack this resource is mapped to.resource_name (
Optional
[str
]) – The name of the resource this resource is mapped to.terraform_source_name (
Optional
[str
]) – The short name of the Terraform source.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_resiliencehub as resiliencehub resource_mapping_property = resiliencehub.CfnApp.ResourceMappingProperty( mapping_type="mappingType", physical_resource_id=resiliencehub.CfnApp.PhysicalResourceIdProperty( identifier="identifier", type="type", # the properties below are optional aws_account_id="awsAccountId", aws_region="awsRegion" ), # the properties below are optional eks_source_name="eksSourceName", logical_stack_name="logicalStackName", resource_name="resourceName", terraform_source_name="terraformSourceName" )
Attributes
- eks_source_name
CfnApp.ResourceMappingProperty.EksSourceName
.
- logical_stack_name
The name of the CloudFormation stack this resource is mapped to.
- mapping_type
Specifies the type of resource mapping.
Valid Values: CfnStack | Resource | AppRegistryApp | ResourceGroup | Terraform
AppRegistryApp - The resource is mapped to another application. The name of the application is contained in the
appRegistryAppName
property.CfnStack - The resource is mapped to a CloudFormation stack. The name of the CloudFormation stack is contained in the
logicalStackName
property.Resource - The resource is mapped to another resource. The name of the resource is contained in the
resourceName
property.ResourceGroup - The resource is mapped to a resource group. The name of the resource group is contained in the
resourceGroupName
property.
- physical_resource_id
The identifier of this resource.
- resource_name
The name of the resource this resource is mapped to.
- terraform_source_name
The short name of the Terraform source.