Interface ICfnAppProps

Properties for defining a CfnApp.

Namespace: Amazon.CDK.AWS.ResilienceHub

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnAppProps

Syntax (vb)

Public Interface ICfnAppProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ResilienceHub;

var cfnAppProps = new CfnAppProps {
    AppTemplateBody = "appTemplateBody",
    Name = "name",
    ResourceMappings = new [] { new ResourceMappingProperty {
        MappingType = "mappingType",
        PhysicalResourceId = new PhysicalResourceIdProperty {
            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 = new [] { new EventSubscriptionProperty {
        EventType = "eventType",
        Name = "name",

        // the properties below are optional
        SnsTopicArn = "snsTopicArn"
    } },
    PermissionModel = new PermissionModelProperty {
        Type = "type",

        // the properties below are optional
        CrossAccountRoleArns = new [] { "crossAccountRoleArns" },
        InvokerRoleName = "invokerRoleName"
    },
    ResiliencyPolicyArn = "resiliencyPolicyArn",
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};

Synopsis

Properties

AppAssessmentSchedule	Assessment execution schedule with 'Daily' or 'Disabled' values.
AppTemplateBody	A JSON string that provides information about your application structure.
Description	Optional description for an application.
EventSubscriptions	The list of events you would like to subscribe and get notification for.
Name	Name for the application.
PermissionModel	Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.
ResiliencyPolicyArn	The Amazon Resource Name (ARN) of the resiliency policy.
ResourceMappings	An array of `ResourceMapping` objects.
Tags	Tags assigned to the resource.

Properties

AppAssessmentSchedule

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

virtual string AppAssessmentSchedule { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-appassessmentschedule

AppTemplateBody

A JSON string that provides information about your application structure.

string AppTemplateBody { get; }

Property Value

System.String

Remarks

To learn more about the appTemplateBody template, see the sample template in Sample appTemplateBody template .

The appTemplateBody JSON string has the following structure:

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

Type: Array

Don&apos;t add the resources that you want to exclude.

Each resources array item includes the following fields:

The logical identifier of the resource.

Type: Object

Each logicalResourceId object includes the following fields:

Identifier of the resource.

Type: String

Name of the AWS CloudFormation stack this resource belongs to.

Type: String

Name of the resource group this resource belongs to.

Type: String

Name of the Terraform S3 state file this resource belongs to.

Type: String

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

This parameter accepts values in &quot;eks-cluster/namespace&quot; format.

Type: String

The type of resource.

Type: string

Name of the resource.

Type: String

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>"}]}]"

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 of the AppComponent.

Type: String

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

Type: String

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

Type: Array of strings

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>"}]}]"

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

Type: Array

Don&apos;t add the resources that you want to include.

Each excludedResources array item includes the following fields:

The logical identifier of the resource.

Type: Object

You can configure only one of the following fields:

Each logicalResourceIds object includes the following fields:

The identifier of the resource.

Type: String

Name of the AWS CloudFormation stack this resource belongs to.

Type: String

Name of the resource group this resource belongs to.

Type: String

Name of the Terraform S3 state file this resource belongs to.

Type: String

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

This parameter accepts values in &quot;eks-cluster/namespace&quot; format.

Type: String

The AWS Resilience Hub application version.

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>"}]}]"

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-apptemplatebody

Description

Optional description for an application.

virtual string Description { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-description

EventSubscriptions

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

virtual object EventSubscriptions { get; }

Property Value

System.Object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-eventsubscriptions

Name

Name for the application.

string Name { get; }

Property Value

System.String

Remarks

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

PermissionModel

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

virtual object PermissionModel { get; }

Property Value

System.Object

Remarks

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

ResiliencyPolicyArn

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

virtual string ResiliencyPolicyArn { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-resiliencypolicyarn

ResourceMappings

An array of ResourceMapping objects.

object ResourceMappings { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html#cfn-resiliencehub-app-resourcemappings