awsroute53recoverycontrol

package
v2.4.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnCluster_CFN_RESOURCE_TYPE_NAME 

func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string

func CfnCluster_IsCfnElement 

func CfnCluster_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 CfnCluster_IsCfnResource 

func CfnCluster_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCluster_IsConstruct 

func CfnCluster_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 CfnControlPanel_CFN_RESOURCE_TYPE_NAME 

func CfnControlPanel_CFN_RESOURCE_TYPE_NAME() *string

func CfnControlPanel_IsCfnElement 

func CfnControlPanel_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 CfnControlPanel_IsCfnResource 

func CfnControlPanel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnControlPanel_IsConstruct 

func CfnControlPanel_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 CfnRoutingControl_CFN_RESOURCE_TYPE_NAME 

func CfnRoutingControl_CFN_RESOURCE_TYPE_NAME() *string

func CfnRoutingControl_IsCfnElement 

func CfnRoutingControl_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 CfnRoutingControl_IsCfnResource 

func CfnRoutingControl_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnRoutingControl_IsConstruct 

func CfnRoutingControl_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 CfnSafetyRule_CFN_RESOURCE_TYPE_NAME 

func CfnSafetyRule_CFN_RESOURCE_TYPE_NAME() *string

func CfnSafetyRule_IsCfnElement 

func CfnSafetyRule_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 CfnSafetyRule_IsCfnResource 

func CfnSafetyRule_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSafetyRule_IsConstruct 

func CfnSafetyRule_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 NewCfnCluster_Override 

func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)

Create a new `AWS::Route53RecoveryControl::Cluster`.

func NewCfnControlPanel_Override 

func NewCfnControlPanel_Override(c CfnControlPanel, scope constructs.Construct, id *string, props *CfnControlPanelProps)

Create a new `AWS::Route53RecoveryControl::ControlPanel`.

func NewCfnRoutingControl_Override 

func NewCfnRoutingControl_Override(c CfnRoutingControl, scope constructs.Construct, id *string, props *CfnRoutingControlProps)

Create a new `AWS::Route53RecoveryControl::RoutingControl`.

func NewCfnSafetyRule_Override 

func NewCfnSafetyRule_Override(c CfnSafetyRule, scope constructs.Construct, id *string, props *CfnSafetyRuleProps)

Create a new `AWS::Route53RecoveryControl::SafetyRule`.

Types

type CfnCluster 

type CfnCluster interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrClusterArn() *string
	AttrClusterEndpoints() awscdk.IResolvable
	AttrStatus() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *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::Route53RecoveryControl::Cluster`.

Returns an array of all the clusters in an account.

TODO: EXAMPLE

func NewCfnCluster 

func NewCfnCluster(scope constructs.Construct, id *string, props *CfnClusterProps) CfnCluster

Create a new `AWS::Route53RecoveryControl::Cluster`.

type CfnClusterProps 

type CfnClusterProps struct {
	// Name of the cluster.
	//
	// You can use any non-white space character in the name.
	Name *string `json:"name"`
	// The value for a tag.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnCluster`.

TODO: EXAMPLE

type CfnCluster_ClusterEndpointProperty 

type CfnCluster_ClusterEndpointProperty struct {
	// A cluster endpoint.
	//
	// Specify an endpoint and AWS Region when you want to set or retrieve a routing control state in the cluster.
	//
	// To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.
	Endpoint *string `json:"endpoint"`
	// The AWS Region for a cluster endpoint.
	Region *string `json:"region"`
}

A cluster endpoint.

Specify an endpoint when you want to set or retrieve a routing control state in the cluster.

TODO: EXAMPLE

type CfnControlPanel 

type CfnControlPanel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrControlPanelArn() *string
	AttrDefaultControlPanel() awscdk.IResolvable
	AttrRoutingControlCount() *float64
	AttrStatus() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ClusterArn() *string
	SetClusterArn(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *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::Route53RecoveryControl::ControlPanel`.

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or AWS Region .

TODO: EXAMPLE

func NewCfnControlPanel 

func NewCfnControlPanel(scope constructs.Construct, id *string, props *CfnControlPanelProps) CfnControlPanel

Create a new `AWS::Route53RecoveryControl::ControlPanel`.

type CfnControlPanelProps 

type CfnControlPanelProps struct {
	// The name of the control panel.
	//
	// You can use any non-white space character in the name.
	Name *string `json:"name"`
	// The Amazon Resource Name (ARN) of the cluster for the control panel.
	ClusterArn *string `json:"clusterArn"`
	// The value for a tag.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnControlPanel`.

TODO: EXAMPLE

type CfnRoutingControl 

type CfnRoutingControl interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrRoutingControlArn() *string
	AttrStatus() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ClusterArn() *string
	SetClusterArn(val *string)
	ControlPanelArn() *string
	SetControlPanelArn(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	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::Route53RecoveryControl::RoutingControl`.

Defines a routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

TODO: EXAMPLE

func NewCfnRoutingControl 

func NewCfnRoutingControl(scope constructs.Construct, id *string, props *CfnRoutingControlProps) CfnRoutingControl

Create a new `AWS::Route53RecoveryControl::RoutingControl`.

type CfnRoutingControlProps 

type CfnRoutingControlProps struct {
	// The name of the routing control.
	//
	// You can use any non-white space character in the name.
	Name *string `json:"name"`
	// The Amazon Resource Name (ARN) of the cluster that includes the routing control.
	ClusterArn *string `json:"clusterArn"`
	// The Amazon Resource Name (ARN) of the control panel that includes the routing control.
	ControlPanelArn *string `json:"controlPanelArn"`
}

Properties for defining a `CfnRoutingControl`.

TODO: EXAMPLE

type CfnSafetyRule 

type CfnSafetyRule interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AssertionRule() interface{}
	SetAssertionRule(val interface{})
	AttrSafetyRuleArn() *string
	AttrStatus() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ControlPanelArn() *string
	SetControlPanelArn(val *string)
	CreationStack() *[]*string
	GatingRule() interface{}
	SetGatingRule(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	RuleConfig() interface{}
	SetRuleConfig(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::Route53RecoveryControl::SafetyRule`.

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

TODO: EXAMPLE

func NewCfnSafetyRule 

func NewCfnSafetyRule(scope constructs.Construct, id *string, props *CfnSafetyRuleProps) CfnSafetyRule

Create a new `AWS::Route53RecoveryControl::SafetyRule`.

type CfnSafetyRuleProps 

type CfnSafetyRuleProps struct {
	// The Amazon Resource Name (ARN) for the control panel.
	ControlPanelArn *string `json:"controlPanelArn"`
	// The name of the assertion rule.
	//
	// You can use any non-white space character in the name. The name must be unique within a control panel.
	Name *string `json:"name"`
	// The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be `ON` as the result of a transaction.
	//
	// For example, if you have three assertion controls, you might specify `ATLEAST 2` for your rule configuration. This means that at least two assertion controls must be `ON` , so that at least two AWS Regions have traffic flowing to them.
	RuleConfig interface{} `json:"ruleConfig"`
	// An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.
	//
	// Otherwise, the change to the routing control is not accepted. For example, the criteria might be that at least one routing control state is `On` after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
	AssertionRule interface{} `json:"assertionRule"`
	// A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.
	//
	// For example, if you specify one gating routing control and you set the `Type` in the rule configuration to `OR` , that indicates that you must set the gating routing control to `On` for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
	GatingRule interface{} `json:"gatingRule"`
	// The value for a tag.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnSafetyRule`.

TODO: EXAMPLE

type CfnSafetyRule_AssertionRuleProperty 

type CfnSafetyRule_AssertionRuleProperty struct {
	// The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed.
	//
	// For example, you might include three routing controls, one for each of three AWS Regions.
	AssertedControls *[]*string `json:"assertedControls"`
	// An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail.
	//
	// This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
	WaitPeriodMs *float64 `json:"waitPeriodMs"`
}

An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.

Otherwise, the change to the routing control is not accepted. For example, the criteria might be that at least one routing control state is `On` after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

TODO: EXAMPLE

type CfnSafetyRule_GatingRuleProperty 

type CfnSafetyRule_GatingRuleProperty struct {
	// An array of gating routing control Amazon Resource Names (ARNs).
	//
	// For a simple "on/off" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.
	GatingControls *[]*string `json:"gatingControls"`
	// An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control.
	//
	// As a simple example, if you have a single gating control, it acts as an overall "on/off" switch for a set of target routing controls. You can use this to manually override automated failover, for example.
	TargetControls *[]*string `json:"targetControls"`
	// An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail.
	//
	// This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.
	WaitPeriodMs *float64 `json:"waitPeriodMs"`
}

A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.

For example, if you specify one gating routing control and you set the `Type` in the rule configuration to `OR` , that indicates that you must set the gating routing control to `On` for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.

TODO: EXAMPLE

type CfnSafetyRule_RuleConfigProperty 

type CfnSafetyRule_RuleConfigProperty struct {
	// Logical negation of the rule.
	//
	// If the rule would usually evaluate true, it's evaluated as false, and vice versa.
	Inverted interface{} `json:"inverted"`
	// The value of N, when you specify an `ATLEAST` rule type.
	//
	// That is, `Threshold` is the number of controls that must be set when you specify an `ATLEAST` type.
	Threshold *float64 `json:"threshold"`
	// A rule can be one of the following: `ATLEAST` , `AND` , or `OR` .
	Type *string `json:"type"`
}

The rule configuration for an assertion rule.

That is, the criteria that you set for specific assertion controls (routing controls) that specify how many control states must be `ON` after a transaction completes.

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.