awsresiliencehub

Documentation

Index

• func CfnApp_CFN_RESOURCE_TYPE_NAME() *string
• func CfnApp_IsCfnElement(x interface{}) *bool
• func CfnApp_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnApp_IsConstruct(x interface{}) *bool
• func CfnResiliencyPolicy_CFN_RESOURCE_TYPE_NAME() *string
• func CfnResiliencyPolicy_IsCfnElement(x interface{}) *bool
• func CfnResiliencyPolicy_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnResiliencyPolicy_IsConstruct(x interface{}) *bool
• func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)
• func NewCfnResiliencyPolicy_Override(c CfnResiliencyPolicy, scope constructs.Construct, id *string, ...)
• type CfnApp
  • func NewCfnApp(scope constructs.Construct, id *string, props *CfnAppProps) CfnApp
• type CfnAppProps
• type CfnApp_PhysicalResourceIdProperty
• type CfnApp_ResourceMappingProperty
• type CfnResiliencyPolicy
  • func NewCfnResiliencyPolicy(scope constructs.Construct, id *string, props *CfnResiliencyPolicyProps) CfnResiliencyPolicy
• type CfnResiliencyPolicyProps
• type CfnResiliencyPolicy_FailurePolicyProperty

Functions

func CfnApp_CFN_RESOURCE_TYPE_NAME

func CfnApp_CFN_RESOURCE_TYPE_NAME() *string

func CfnApp_IsCfnElement

func CfnApp_IsCfnElement(x interface{}) *bool

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.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnApp_IsCfnResource

func CfnApp_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnApp_IsConstruct

func CfnApp_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnResiliencyPolicy_CFN_RESOURCE_TYPE_NAME

func CfnResiliencyPolicy_CFN_RESOURCE_TYPE_NAME() *string

func CfnResiliencyPolicy_IsCfnElement

func CfnResiliencyPolicy_IsCfnElement(x interface{}) *bool

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.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnResiliencyPolicy_IsCfnResource

func CfnResiliencyPolicy_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnResiliencyPolicy_IsConstruct

func CfnResiliencyPolicy_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnApp_Override

func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)

Create a new `AWS::ResilienceHub::App`.

func NewCfnResiliencyPolicy_Override

func NewCfnResiliencyPolicy_Override(c CfnResiliencyPolicy, scope constructs.Construct, id *string, props *CfnResiliencyPolicyProps)

Create a new `AWS::ResilienceHub::ResiliencyPolicy`.

Types

type CfnApp

type CfnApp interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AppTemplateBody() *string
	SetAppTemplateBody(val *string)
	AttrAppArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	ResiliencyPolicyArn() *string
	SetResiliencyPolicyArn(val *string)
	ResourceMappings() interface{}
	SetResourceMappings(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ResilienceHub::App`.

Creates a Resilience Hub application. A Resilience Hub application is a collection of AWS resources structured to prevent and recover AWS application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more–up to five– AWS CloudFormation stacks, and an appropriate resiliency policy.

After you create a 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).

TODO: EXAMPLE

func NewCfnApp

func NewCfnApp(scope constructs.Construct, id *string, props *CfnAppProps) CfnApp

Create a new `AWS::ResilienceHub::App`.

type CfnAppProps

type CfnAppProps struct {
	// A string containing a full Resilience Hub app template body.
	AppTemplateBody *string `json:"appTemplateBody" yaml:"appTemplateBody"`
	// The name for the application.
	Name *string `json:"name" yaml:"name"`
	// An array of ResourceMapping objects.
	ResourceMappings interface{} `json:"resourceMappings" yaml:"resourceMappings"`
	// The optional description for an app.
	Description *string `json:"description" yaml:"description"`
	// The Amazon Resource Name (ARN) of the resiliency policy.
	ResiliencyPolicyArn *string `json:"resiliencyPolicyArn" yaml:"resiliencyPolicyArn"`
	// 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.
	Tags *map[string]*string `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnApp`.

TODO: EXAMPLE

type CfnApp_PhysicalResourceIdProperty

type CfnApp_PhysicalResourceIdProperty struct {
	// The identifier of the physical resource.
	Identifier *string `json:"identifier" yaml:"identifier"`
	// Specifies the type of physical resource identifier.
	//
	// - **Arn** - The resource identifier is an Amazon Resource Name (ARN) .
	// - **Native** - The resource identifier is a Resilience Hub-native identifier.
	Type *string `json:"type" yaml:"type"`
	// The AWS account that owns the physical resource.
	AwsAccountId *string `json:"awsAccountId" yaml:"awsAccountId"`
	// The AWS Region that the physical resource is located in.
	AwsRegion *string `json:"awsRegion" yaml:"awsRegion"`
}

Defines a physical resource identifier.

TODO: EXAMPLE

type CfnApp_ResourceMappingProperty

type CfnApp_ResourceMappingProperty struct {
	// Specifies the type of resource mapping.
	//
	// - **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.
	MappingType *string `json:"mappingType" yaml:"mappingType"`
	// The identifier of this resource.
	PhysicalResourceId interface{} `json:"physicalResourceId" yaml:"physicalResourceId"`
	// The name of the CloudFormation stack this resource is mapped to.
	LogicalStackName *string `json:"logicalStackName" yaml:"logicalStackName"`
	// The name of the resource this resource is mapped to.
	ResourceName *string `json:"resourceName" yaml:"resourceName"`
}

Defines a resource mapping.

TODO: EXAMPLE

type CfnResiliencyPolicy

type CfnResiliencyPolicy interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrPolicyArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataLocationConstraint() *string
	SetDataLocationConstraint(val *string)
	LogicalId() *string
	Node() constructs.Node
	Policy() interface{}
	SetPolicy(val interface{})
	PolicyDescription() *string
	SetPolicyDescription(val *string)
	PolicyName() *string
	SetPolicyName(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Tier() *string
	SetTier(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ResilienceHub::ResiliencyPolicy`.

Defines a resiliency policy.

TODO: EXAMPLE

func NewCfnResiliencyPolicy

func NewCfnResiliencyPolicy(scope constructs.Construct, id *string, props *CfnResiliencyPolicyProps) CfnResiliencyPolicy

Create a new `AWS::ResilienceHub::ResiliencyPolicy`.

type CfnResiliencyPolicyProps

type CfnResiliencyPolicyProps struct {
	// The resiliency policy.
	Policy interface{} `json:"policy" yaml:"policy"`
	// The name of the policy.
	PolicyName *string `json:"policyName" yaml:"policyName"`
	// The tier for this resiliency policy, ranging from the highest severity ( `MissionCritical` ) to lowest ( `NonCritical` ).
	Tier *string `json:"tier" yaml:"tier"`
	// Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
	DataLocationConstraint *string `json:"dataLocationConstraint" yaml:"dataLocationConstraint"`
	// The description for the policy.
	PolicyDescription *string `json:"policyDescription" yaml:"policyDescription"`
	// 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.
	Tags *map[string]*string `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnResiliencyPolicy`.

TODO: EXAMPLE

type CfnResiliencyPolicy_FailurePolicyProperty

type CfnResiliencyPolicy_FailurePolicyProperty struct {
	// The Recovery Point Objective (RPO), in seconds.
	RpoInSecs *float64 `json:"rpoInSecs" yaml:"rpoInSecs"`
	// The Recovery Time Objective (RTO), in seconds.
	RtoInSecs *float64 `json:"rtoInSecs" yaml:"rtoInSecs"`
}

Defines a failure policy.

TODO: EXAMPLE