awsroute53recoveryreadiness

package
v2.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnCell_CFN_RESOURCE_TYPE_NAME 

func CfnCell_CFN_RESOURCE_TYPE_NAME() *string

func CfnCell_IsCfnElement 

func CfnCell_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 CfnCell_IsCfnResource 

func CfnCell_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCell_IsConstruct 

func CfnCell_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 CfnReadinessCheck_CFN_RESOURCE_TYPE_NAME 

func CfnReadinessCheck_CFN_RESOURCE_TYPE_NAME() *string

func CfnReadinessCheck_IsCfnElement 

func CfnReadinessCheck_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 CfnReadinessCheck_IsCfnResource 

func CfnReadinessCheck_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnReadinessCheck_IsConstruct 

func CfnReadinessCheck_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 CfnRecoveryGroup_CFN_RESOURCE_TYPE_NAME 

func CfnRecoveryGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnRecoveryGroup_IsCfnElement 

func CfnRecoveryGroup_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 CfnRecoveryGroup_IsCfnResource 

func CfnRecoveryGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnRecoveryGroup_IsConstruct 

func CfnRecoveryGroup_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 CfnResourceSet_CFN_RESOURCE_TYPE_NAME 

func CfnResourceSet_CFN_RESOURCE_TYPE_NAME() *string

func CfnResourceSet_IsCfnElement 

func CfnResourceSet_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 CfnResourceSet_IsCfnResource 

func CfnResourceSet_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnResourceSet_IsConstruct 

func CfnResourceSet_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 NewCfnCell_Override 

func NewCfnCell_Override(c CfnCell, scope constructs.Construct, id *string, props *CfnCellProps)

Create a new `AWS::Route53RecoveryReadiness::Cell`.

func NewCfnReadinessCheck_Override 

func NewCfnReadinessCheck_Override(c CfnReadinessCheck, scope constructs.Construct, id *string, props *CfnReadinessCheckProps)

Create a new `AWS::Route53RecoveryReadiness::ReadinessCheck`.

func NewCfnRecoveryGroup_Override 

func NewCfnRecoveryGroup_Override(c CfnRecoveryGroup, scope constructs.Construct, id *string, props *CfnRecoveryGroupProps)

Create a new `AWS::Route53RecoveryReadiness::RecoveryGroup`.

func NewCfnResourceSet_Override 

func NewCfnResourceSet_Override(c CfnResourceSet, scope constructs.Construct, id *string, props *CfnResourceSetProps)

Create a new `AWS::Route53RecoveryReadiness::ResourceSet`.

Types

type CfnCell 

type CfnCell interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the cell.
	AttrCellArn() *string
	// The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN.
	//
	// This is a list but currently can have only one element.
	AttrParentReadinessScopes() *[]*string
	// The name of the cell to create.
	CellName() *string
	SetCellName(val *string)
	// A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells.
	//
	// For example, Availability Zones within specific AWS Regions .
	Cells() *[]*string
	SetCells(val *[]*string)
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: 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.
	CreationStack() *[]*string
	// 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.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// 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 })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// A collection of tags associated with a resource.
	Tags() awscdk.TagManager
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: 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.
	//
	AddMetadata(key *string, value interface{})
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: 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.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Route53RecoveryReadiness::Cell`.

Creates a cell in an account.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
cfnCell := route53recoveryreadiness.NewCfnCell(this, jsii.String("MyCfnCell"), &cfnCellProps{
	cellName: jsii.String("cellName"),

	// the properties below are optional
	cells: []*string{
		jsii.String("cells"),
	},
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
})

func NewCfnCell 

func NewCfnCell(scope constructs.Construct, id *string, props *CfnCellProps) CfnCell

Create a new `AWS::Route53RecoveryReadiness::Cell`.

type CfnCellProps 

type CfnCellProps struct {
	// The name of the cell to create.
	CellName *string `json:"cellName" yaml:"cellName"`
	// A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells.
	//
	// For example, Availability Zones within specific AWS Regions .
	Cells *[]*string `json:"cells" yaml:"cells"`
	// A collection of tags associated with a resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnCell`.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
cfnCellProps := &cfnCellProps{
	cellName: jsii.String("cellName"),

	// the properties below are optional
	cells: []*string{
		jsii.String("cells"),
	},
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
}

type CfnReadinessCheck 

type CfnReadinessCheck interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the readiness check.
	AttrReadinessCheckArn() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: 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.
	CreationStack() *[]*string
	// 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.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// The name of the readiness check to create.
	ReadinessCheckName() *string
	SetReadinessCheckName(val *string)
	// 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 })`.
	Ref() *string
	// The name of the resource set to check.
	ResourceSetName() *string
	SetResourceSetName(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// A collection of tags associated with a resource.
	Tags() awscdk.TagManager
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: 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.
	//
	AddMetadata(key *string, value interface{})
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: 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.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Route53RecoveryReadiness::ReadinessCheck`.

Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
cfnReadinessCheck := route53recoveryreadiness.NewCfnReadinessCheck(this, jsii.String("MyCfnReadinessCheck"), &cfnReadinessCheckProps{
	readinessCheckName: jsii.String("readinessCheckName"),

	// the properties below are optional
	resourceSetName: jsii.String("resourceSetName"),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
})

func NewCfnReadinessCheck 

func NewCfnReadinessCheck(scope constructs.Construct, id *string, props *CfnReadinessCheckProps) CfnReadinessCheck

Create a new `AWS::Route53RecoveryReadiness::ReadinessCheck`.

type CfnReadinessCheckProps 

type CfnReadinessCheckProps struct {
	// The name of the readiness check to create.
	ReadinessCheckName *string `json:"readinessCheckName" yaml:"readinessCheckName"`
	// The name of the resource set to check.
	ResourceSetName *string `json:"resourceSetName" yaml:"resourceSetName"`
	// A collection of tags associated with a resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnReadinessCheck`.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
cfnReadinessCheckProps := &cfnReadinessCheckProps{
	readinessCheckName: jsii.String("readinessCheckName"),

	// the properties below are optional
	resourceSetName: jsii.String("resourceSetName"),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
}

type CfnRecoveryGroup 

type CfnRecoveryGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the recovery group.
	AttrRecoveryGroupArn() *string
	// A list of the cell Amazon Resource Names (ARNs) in the recovery group.
	Cells() *[]*string
	SetCells(val *[]*string)
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: 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.
	CreationStack() *[]*string
	// 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.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// The name of the recovery group to create.
	RecoveryGroupName() *string
	SetRecoveryGroupName(val *string)
	// 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 })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// A collection of tags associated with a resource.
	Tags() awscdk.TagManager
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: 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.
	//
	AddMetadata(key *string, value interface{})
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: 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.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Route53RecoveryReadiness::RecoveryGroup`.

Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
cfnRecoveryGroup := route53recoveryreadiness.NewCfnRecoveryGroup(this, jsii.String("MyCfnRecoveryGroup"), &cfnRecoveryGroupProps{
	recoveryGroupName: jsii.String("recoveryGroupName"),

	// the properties below are optional
	cells: []*string{
		jsii.String("cells"),
	},
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
})

func NewCfnRecoveryGroup 

func NewCfnRecoveryGroup(scope constructs.Construct, id *string, props *CfnRecoveryGroupProps) CfnRecoveryGroup

Create a new `AWS::Route53RecoveryReadiness::RecoveryGroup`.

type CfnRecoveryGroupProps 

type CfnRecoveryGroupProps struct {
	// The name of the recovery group to create.
	RecoveryGroupName *string `json:"recoveryGroupName" yaml:"recoveryGroupName"`
	// A list of the cell Amazon Resource Names (ARNs) in the recovery group.
	Cells *[]*string `json:"cells" yaml:"cells"`
	// A collection of tags associated with a resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnRecoveryGroup`.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
cfnRecoveryGroupProps := &cfnRecoveryGroupProps{
	recoveryGroupName: jsii.String("recoveryGroupName"),

	// the properties below are optional
	cells: []*string{
		jsii.String("cells"),
	},
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
}

type CfnResourceSet 

type CfnResourceSet interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the resource set.
	AttrResourceSetArn() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: 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.
	CreationStack() *[]*string
	// 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.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// 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 })`.
	Ref() *string
	// A list of resource objects in the resource set.
	Resources() interface{}
	SetResources(val interface{})
	// The name of the resource set to create.
	ResourceSetName() *string
	SetResourceSetName(val *string)
	// The resource type of the resources in the resource set. Enter one of the following values for resource type:.
	//
	// AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource.
	//
	// Note that AWS::Route53RecoveryReadiness::DNSTargetResource is only used for this setting. It isn't an actual AWS CloudFormation resource type.
	ResourceSetType() *string
	SetResourceSetType(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// A tag to associate with the parameters for a resource set.
	Tags() awscdk.TagManager
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: 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.
	//
	AddMetadata(key *string, value interface{})
	// 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "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.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: 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.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Route53RecoveryReadiness::ResourceSet`.

Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
cfnResourceSet := route53recoveryreadiness.NewCfnResourceSet(this, jsii.String("MyCfnResourceSet"), &cfnResourceSetProps{
	resources: []interface{}{
		&resourceProperty{
			componentId: jsii.String("componentId"),
			dnsTargetResource: &dNSTargetResourceProperty{
				domainName: jsii.String("domainName"),
				hostedZoneArn: jsii.String("hostedZoneArn"),
				recordSetId: jsii.String("recordSetId"),
				recordType: jsii.String("recordType"),
				targetResource: &targetResourceProperty{
					nlbResource: &nLBResourceProperty{
						arn: jsii.String("arn"),
					},
					r53Resource: &r53ResourceRecordProperty{
						domainName: jsii.String("domainName"),
						recordSetId: jsii.String("recordSetId"),
					},
				},
			},
			readinessScopes: []*string{
				jsii.String("readinessScopes"),
			},
			resourceArn: jsii.String("resourceArn"),
		},
	},
	resourceSetName: jsii.String("resourceSetName"),
	resourceSetType: jsii.String("resourceSetType"),

	// the properties below are optional
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
})

func NewCfnResourceSet 

func NewCfnResourceSet(scope constructs.Construct, id *string, props *CfnResourceSetProps) CfnResourceSet

Create a new `AWS::Route53RecoveryReadiness::ResourceSet`.

type CfnResourceSetProps 

type CfnResourceSetProps struct {
	// A list of resource objects in the resource set.
	Resources interface{} `json:"resources" yaml:"resources"`
	// The name of the resource set to create.
	ResourceSetName *string `json:"resourceSetName" yaml:"resourceSetName"`
	// The resource type of the resources in the resource set. Enter one of the following values for resource type:.
	//
	// AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource.
	//
	// Note that AWS::Route53RecoveryReadiness::DNSTargetResource is only used for this setting. It isn't an actual AWS CloudFormation resource type.
	ResourceSetType *string `json:"resourceSetType" yaml:"resourceSetType"`
	// A tag to associate with the parameters for a resource set.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnResourceSet`.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
cfnResourceSetProps := &cfnResourceSetProps{
	resources: []interface{}{
		&resourceProperty{
			componentId: jsii.String("componentId"),
			dnsTargetResource: &dNSTargetResourceProperty{
				domainName: jsii.String("domainName"),
				hostedZoneArn: jsii.String("hostedZoneArn"),
				recordSetId: jsii.String("recordSetId"),
				recordType: jsii.String("recordType"),
				targetResource: &targetResourceProperty{
					nlbResource: &nLBResourceProperty{
						arn: jsii.String("arn"),
					},
					r53Resource: &r53ResourceRecordProperty{
						domainName: jsii.String("domainName"),
						recordSetId: jsii.String("recordSetId"),
					},
				},
			},
			readinessScopes: []*string{
				jsii.String("readinessScopes"),
			},
			resourceArn: jsii.String("resourceArn"),
		},
	},
	resourceSetName: jsii.String("resourceSetName"),
	resourceSetType: jsii.String("resourceSetType"),

	// the properties below are optional
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
}

type CfnResourceSet_DNSTargetResourceProperty 

type CfnResourceSet_DNSTargetResourceProperty struct {
	// The domain name that acts as an ingress point to a portion of the customer application.
	DomainName *string `json:"domainName" yaml:"domainName"`
	// The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.
	HostedZoneArn *string `json:"hostedZoneArn" yaml:"hostedZoneArn"`
	// The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.
	RecordSetId *string `json:"recordSetId" yaml:"recordSetId"`
	// The type of DNS record of the target resource.
	RecordType *string `json:"recordType" yaml:"recordType"`
	// The target resource that the Route 53 record points to.
	TargetResource interface{} `json:"targetResource" yaml:"targetResource"`
}

A component for DNS/routing control readiness checks and architecture checks.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
dNSTargetResourceProperty := &dNSTargetResourceProperty{
	domainName: jsii.String("domainName"),
	hostedZoneArn: jsii.String("hostedZoneArn"),
	recordSetId: jsii.String("recordSetId"),
	recordType: jsii.String("recordType"),
	targetResource: &targetResourceProperty{
		nlbResource: &nLBResourceProperty{
			arn: jsii.String("arn"),
		},
		r53Resource: &r53ResourceRecordProperty{
			domainName: jsii.String("domainName"),
			recordSetId: jsii.String("recordSetId"),
		},
	},
}

type CfnResourceSet_NLBResourceProperty 

type CfnResourceSet_NLBResourceProperty struct {
	// The Network Load Balancer resource Amazon Resource Name (ARN).
	Arn *string `json:"arn" yaml:"arn"`
}

The Network Load Balancer resource that a DNS target resource points to.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
nLBResourceProperty := &nLBResourceProperty{
	arn: jsii.String("arn"),
}

type CfnResourceSet_R53ResourceRecordProperty 

type CfnResourceSet_R53ResourceRecordProperty struct {
	// The DNS target domain name.
	DomainName *string `json:"domainName" yaml:"domainName"`
	// The Route 53 Resource Record Set ID.
	RecordSetId *string `json:"recordSetId" yaml:"recordSetId"`
}

The Route 53 resource that a DNS target resource record points to.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
r53ResourceRecordProperty := &r53ResourceRecordProperty{
	domainName: jsii.String("domainName"),
	recordSetId: jsii.String("recordSetId"),
}

type CfnResourceSet_ResourceProperty 

type CfnResourceSet_ResourceProperty struct {
	// The component identifier of the resource, generated when DNS target resource is used.
	ComponentId *string `json:"componentId" yaml:"componentId"`
	// A component for DNS/routing control readiness checks.
	//
	// This is a required setting when `ResourceSet` `ResourceSetType` is set to `AWS::Route53RecoveryReadiness::DNSTargetResource` . Do not set it for any other `ResourceSetType` setting.
	DnsTargetResource interface{} `json:"dnsTargetResource" yaml:"dnsTargetResource"`
	// The recovery group Amazon Resource Name (ARN) or the cell ARN that the readiness checks for this resource set are scoped to.
	ReadinessScopes *[]*string `json:"readinessScopes" yaml:"readinessScopes"`
	// The Amazon Resource Name (ARN) of the AWS resource.
	//
	// This is a required setting for all `ResourceSet` `ResourceSetType` settings except `AWS::Route53RecoveryReadiness::DNSTargetResource` . Do not set this when `ResourceSetType` is set to `AWS::Route53RecoveryReadiness::DNSTargetResource` .
	ResourceArn *string `json:"resourceArn" yaml:"resourceArn"`
}

The resource element of a resource set.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
resourceProperty := &resourceProperty{
	componentId: jsii.String("componentId"),
	dnsTargetResource: &dNSTargetResourceProperty{
		domainName: jsii.String("domainName"),
		hostedZoneArn: jsii.String("hostedZoneArn"),
		recordSetId: jsii.String("recordSetId"),
		recordType: jsii.String("recordType"),
		targetResource: &targetResourceProperty{
			nlbResource: &nLBResourceProperty{
				arn: jsii.String("arn"),
			},
			r53Resource: &r53ResourceRecordProperty{
				domainName: jsii.String("domainName"),
				recordSetId: jsii.String("recordSetId"),
			},
		},
	},
	readinessScopes: []*string{
		jsii.String("readinessScopes"),
	},
	resourceArn: jsii.String("resourceArn"),
}

type CfnResourceSet_TargetResourceProperty 

type CfnResourceSet_TargetResourceProperty struct {
	// The Network Load Balancer resource that a DNS target resource points to.
	NlbResource interface{} `json:"nlbResource" yaml:"nlbResource"`
	// The Route 53 resource that a DNS target resource record points to.
	R53Resource interface{} `json:"r53Resource" yaml:"r53Resource"`
}

The target resource that the Route 53 record points to.

Example: 

import awscdk "github.com/aws/aws-cdk-go/awscdk"import route53recoveryreadiness "github.com/aws/aws-cdk-go/awscdk/aws_route53recoveryreadiness"
targetResourceProperty := &targetResourceProperty{
	nlbResource: &nLBResourceProperty{
		arn: jsii.String("arn"),
	},
	r53Resource: &r53ResourceRecordProperty{
		domainName: jsii.String("domainName"),
		recordSetId: jsii.String("recordSetId"),
	},
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.