Class CfnApp
Creates an AWS Resilience Hub application.
Inherited Members
Namespace: Amazon.CDK.AWS.ResilienceHub
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApp : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnApp
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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
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 cfnApp = new CfnApp(this, "MyCfnApp", 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
Constructors
CfnApp(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApp(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnApp(Construct, String, ICfnAppProps) |
Properties
AppAssessmentSchedule | Assessment execution schedule with 'Daily' or 'Disabled' values. |
AppTemplateBody | A JSON string that provides information about your application structure. |
AttrAppArn | The Amazon Resource Name (ARN) of the applcation. |
AttrDriftStatus | Indicates if compliance drifts (deviations) were detected while running an assessment for your application. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Tags assigned to the resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApp(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApp(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApp(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApp(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnApp(Construct, String, ICfnAppProps)
public CfnApp(Construct scope, string id, ICfnAppProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnAppProps
Resource properties.
Properties
AppAssessmentSchedule
Assessment execution schedule with 'Daily' or 'Disabled' values.
public virtual string AppAssessmentSchedule { get; set; }
Property Value
System.String
AppTemplateBody
A JSON string that provides information about your application structure.
public virtual string AppTemplateBody { get; set; }
Property Value
System.String
AttrAppArn
The Amazon Resource Name (ARN) of the applcation.
public virtual string AttrAppArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AppArn
AttrDriftStatus
Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
public virtual string AttrDriftStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DriftStatus
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
Optional description for an application.
public virtual string Description { get; set; }
Property Value
System.String
EventSubscriptions
The list of events you would like to subscribe and get notification for.
public virtual object EventSubscriptions { get; set; }
Property Value
System.Object
Name
Name for the application.
public virtual string Name { get; set; }
Property Value
System.String
PermissionModel
Defines the roles and credentials that AWS Resilience Hub would use while creating the application, importing its resources, and running an assessment.
public virtual object PermissionModel { get; set; }
Property Value
System.Object
ResiliencyPolicyArn
The Amazon Resource Name (ARN) of the resiliency policy.
public virtual string ResiliencyPolicyArn { get; set; }
Property Value
System.String
ResourceMappings
An array of ResourceMapping
objects.
public virtual object ResourceMappings { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Tags assigned to the resource.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>