CfnApp

class aws_cdk.aws_resiliencehub.CfnApp(scope, id, *, app_template_body, name, resource_mappings, app_assessment_schedule=None, description=None, event_subscriptions=None, permission_model=None, resiliency_policy_arn=None, tags=None)

Bases: CfnResource

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html
CloudformationResource:: AWS::ResilienceHub::App
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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",
    event_subscriptions=[resiliencehub.CfnApp.EventSubscriptionProperty(
        event_type="eventType",
        name="name",

        # the properties below are optional
        sns_topic_arn="snsTopicArn"
    )],
    permission_model=resiliencehub.CfnApp.PermissionModelProperty(
        type="type",

        # the properties below are optional
        cross_account_role_arns=["crossAccountRoleArns"],
        invoker_role_name="invokerRoleName"
    ),
    resiliency_policy_arn="resiliencyPolicyArn",
    tags={
        "tags_key": "tags"
    }
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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 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 .. 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 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. .. epigraph:: 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 . .. 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 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 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. .. 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>"}]}]"
name (str) – Name for the application.
resource_mappings (Union[IResolvable, Sequence[Union[IResolvable, ResourceMappingProperty, Dict[str, Any]]]]) – An array of ResourceMapping objects.
app_assessment_schedule (Optional[str]) – Assessment execution schedule with ‘Daily’ or ‘Disabled’ values.
description (Optional[str]) – Optional description for an application.
event_subscriptions (Union[IResolvable, Sequence[Union[IResolvable, EventSubscriptionProperty, Dict[str, Any]]], None]) – 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.
permission_model (Union[IResolvable, PermissionModelProperty, Dict[str, Any], None]) – Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.
resiliency_policy_arn (Optional[str]) – The Amazon Resource Name (ARN) of the resiliency policy.
tags (Optional[Mapping[str, str]]) – 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_dependency(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_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

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.

add_override(path, 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:

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

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate 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). 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:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

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)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

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

remove_dependency(target)

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.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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.

attr_app_arn

The Amazon Resource Name (ARN) of the applcation.

CloudformationAttribute:: AppArn

attr_drift_status

Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

CloudformationAttribute:: DriftStatus

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: Optional description for an application.

event_subscriptions: The list of events you would like to subscribe and get notification for.

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: Name for the application.

node: The tree node.

permission_model: Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.

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: Tag Manager which manages the tags for this resource.

tags_raw: Tags assigned to the resource.

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(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

EventSubscriptionProperty

class CfnApp.EventSubscriptionProperty(*, event_type, name, sns_topic_arn=None)

Bases: object

Indicates an event you would like to subscribe and get notification for.

Currently, AWS Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

Parameters:

event_type (str) – The type of event you would like to subscribe and get notification for. Currently, AWS Resilience Hub supports notifications only for Drift detected ( DriftDetected ) and Scheduled assessment failure ( ScheduledAssessmentFailure ) events.
name (str) – Unique name to identify an event subscription.
sns_topic_arn (Optional[str]) – Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: arn:partition:sns:region:account:topic-name . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-eventsubscription.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_resiliencehub as resiliencehub

event_subscription_property = resiliencehub.CfnApp.EventSubscriptionProperty(
    event_type="eventType",
    name="name",

    # the properties below are optional
    sns_topic_arn="snsTopicArn"
)

Attributes

event_type

The type of event you would like to subscribe and get notification for.

Currently, AWS Resilience Hub supports notifications only for Drift detected ( DriftDetected ) and Scheduled assessment failure ( ScheduledAssessmentFailure ) events.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-eventsubscription.html#cfn-resiliencehub-app-eventsubscription-eventtype

name

Unique name to identify an event subscription.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-eventsubscription.html#cfn-resiliencehub-app-eventsubscription-name

sns_topic_arn

Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic.

The format for this ARN is: arn:partition:sns:region:account:topic-name . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-eventsubscription.html#cfn-resiliencehub-app-eventsubscription-snstopicarn

PermissionModelProperty

class CfnApp.PermissionModelProperty(*, type, cross_account_role_arns=None, invoker_role_name=None)

Bases: object

Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.

Parameters:

type (str) – Defines how AWS Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your AWS account, or by using the credentials of the current IAM user.
cross_account_role_arns (Optional[Sequence[str]]) – Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application. .. epigraph:: - These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts. - These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the primary account.
invoker_role_name (Optional[str]) – Existing AWS IAM role name in the primary AWS account that will be assumed by AWS Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment. .. epigraph:: - You must have iam:passRole permission for this role while creating or updating the application. - Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-permissionmodel.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_resiliencehub as resiliencehub

permission_model_property = resiliencehub.CfnApp.PermissionModelProperty(
    type="type",

    # the properties below are optional
    cross_account_role_arns=["crossAccountRoleArns"],
    invoker_role_name="invokerRoleName"
)

Attributes

cross_account_role_arns

Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts.

These ARNs are used for querying purposes while importing resources and assessing your application. .. epigraph:

- These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.
- These roles must have a trust policy with ``iam:AssumeRole`` permission to the invoker role in the primary account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-permissionmodel.html#cfn-resiliencehub-app-permissionmodel-crossaccountrolearns

invoker_role_name

Existing AWS IAM role name in the primary AWS account that will be assumed by AWS Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.

You must have iam:passRole permission for this role while creating or updating the application.

Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-permissionmodel.html#cfn-resiliencehub-app-permissionmodel-invokerrolename

type

Defines how AWS Resilience Hub scans your resources.

It can scan for the resources by using a pre-existing role in your AWS account, or by using the credentials of the current IAM user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-permissionmodel.html#cfn-resiliencehub-app-permissionmodel-type

PhysicalResourceIdProperty

class CfnApp.PhysicalResourceIdProperty(*, identifier, type, aws_account_id=None, aws_region=None)

Bases: object

Defines a physical resource identifier.

Parameters:

identifier (str) – Identifier of the physical resource.
type (str) – Specifies the type of physical resource identifier. - Arn - The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources: - AWS::ECS::Service - AWS::EFS::FileSystem - AWS::ElasticLoadBalancingV2::LoadBalancer - AWS::Lambda::Function - AWS::SNS::Topic - Native - The resource identifier is an AWS Resilience Hub -native identifier and it can identify the following list of resources: - AWS::ApiGateway::RestApi - AWS::ApiGatewayV2::Api - AWS::AutoScaling::AutoScalingGroup - AWS::DocDB::DBCluster - AWS::DocDB::DBGlobalCluster - AWS::DocDB::DBInstance - AWS::DynamoDB::GlobalTable - AWS::DynamoDB::Table - AWS::EC2::EC2Fleet - AWS::EC2::Instance - AWS::EC2::NatGateway - AWS::EC2::Volume - AWS::ElasticLoadBalancing::LoadBalancer - AWS::RDS::DBCluster - AWS::RDS::DBInstance - AWS::RDS::GlobalCluster - AWS::Route53::RecordSet - AWS::S3::Bucket - AWS::SQS::Queue
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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html#cfn-resiliencehub-app-physicalresourceid-awsaccountid

aws_region

The AWS Region that the physical resource is located in.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html#cfn-resiliencehub-app-physicalresourceid-awsregion

identifier

Identifier of the physical resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html#cfn-resiliencehub-app-physicalresourceid-identifier

type

Specifies the type of physical resource identifier.

Arn - The resource identifier is an Amazon Resource Name (ARN) and it can identify the following list of resources:
AWS::ECS::Service
AWS::EFS::FileSystem
AWS::ElasticLoadBalancingV2::LoadBalancer
AWS::Lambda::Function
AWS::SNS::Topic
Native - The resource identifier is an AWS Resilience Hub -native identifier and it can identify the following list of resources:
AWS::ApiGateway::RestApi
AWS::ApiGatewayV2::Api
AWS::AutoScaling::AutoScalingGroup
AWS::DocDB::DBCluster
AWS::DocDB::DBGlobalCluster
AWS::DocDB::DBInstance
AWS::DynamoDB::GlobalTable
AWS::DynamoDB::Table
AWS::EC2::EC2Fleet
AWS::EC2::Instance
AWS::EC2::NatGateway
AWS::EC2::Volume
AWS::ElasticLoadBalancing::LoadBalancer
AWS::RDS::DBCluster
AWS::RDS::DBInstance
AWS::RDS::GlobalCluster
AWS::Route53::RecordSet
AWS::S3::Bucket
AWS::SQS::Queue

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html#cfn-resiliencehub-app-physicalresourceid-type

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.
physical_resource_id (Union[IResolvable, PhysicalResourceIdProperty, Dict[str, Any]]) – Identifier of the physical resource.
eks_source_name (Optional[str]) – Name of the Amazon Elastic Kubernetes Service cluster and namespace that this resource is mapped to when the mappingType is EKS . .. epigraph:: This parameter accepts values in “eks-cluster/namespace” format.
logical_stack_name (Optional[str]) – Name of the AWS CloudFormation stack this resource is mapped to when the mappingType is CfnStack .
resource_name (Optional[str]) – Name of the resource that this resource is mapped to when the mappingType is Resource .
terraform_source_name (Optional[str]) – Name of the Terraform source that this resource is mapped to when the mappingType is Terraform .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-resourcemapping.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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"
)