awsroute53recoveryreadiness

package
v2.16.0 Latest Latest
Warning

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

 Go to latest Published: Mar 12, 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
	AttrCellArn() *string
	AttrParentReadinessScopes() *[]*string
	CellName() *string
	SetCellName(val *string)
	Cells() *[]*string
	SetCells(val *[]*string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	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::Route53RecoveryReadiness::Cell`.

Creates a cell in an account.

TODO: EXAMPLE

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

TODO: EXAMPLE

type CfnReadinessCheck 

type CfnReadinessCheck interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrReadinessCheckArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	ReadinessCheckName() *string
	SetReadinessCheckName(val *string)
	Ref() *string
	ResourceSetName() *string
	SetResourceSetName(val *string)
	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::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.

TODO: EXAMPLE

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

TODO: EXAMPLE

type CfnRecoveryGroup 

type CfnRecoveryGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrRecoveryGroupArn() *string
	Cells() *[]*string
	SetCells(val *[]*string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	RecoveryGroupName() *string
	SetRecoveryGroupName(val *string)
	Ref() *string
	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::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.

TODO: EXAMPLE

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

TODO: EXAMPLE

type CfnResourceSet 

type CfnResourceSet interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrResourceSetArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Resources() interface{}
	SetResources(val interface{})
	ResourceSetName() *string
	SetResourceSetName(val *string)
	ResourceSetType() *string
	SetResourceSetType(val *string)
	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::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.

TODO: EXAMPLE

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

TODO: EXAMPLE

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.

TODO: EXAMPLE

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.

TODO: EXAMPLE

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.

TODO: EXAMPLE

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.

TODO: EXAMPLE

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.

TODO: EXAMPLE

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.