software.amazon.awscdk.services.route53recoverycontrol

Class CfnControlPanel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.route53recoverycontrol.CfnControlPanel

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:37.874Z")
 @Stability(value=Stable)
public class CfnControlPanel
extends CfnResource
implements IInspectable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.route53recoverycontrol.*;
 CfnControlPanel cfnControlPanel = CfnControlPanel.Builder.create(this, "MyCfnControlPanel")
         .name("name")
         // the properties below are optional
         .clusterArn("clusterArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnControlPanel.Builder A fluent builder for CfnControlPanel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnControlPanel(Construct scope, String id, CfnControlPanelProps props) Create a new `AWS::Route53RecoveryControl::ControlPanel`.
protected	CfnControlPanel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnControlPanel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrControlPanelArn() The Amazon Resource Name (ARN) of the control panel.
IResolvable	getAttrDefaultControlPanel() The boolean flag that is set to true for the default control panel in the cluster.
Number	getAttrRoutingControlCount() The number of routing controls in the control panel.
String	getAttrStatus() The deployment status of control panel.
protected Map<String,Object>	getCfnProperties()
String	getClusterArn() The Amazon Resource Name (ARN) of the cluster for the control panel.
String	getName() The name of the control panel.
TagManager	getTags() The value for a tag.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setClusterArn(String value) The Amazon Resource Name (ARN) of the cluster for the control panel.
void	setName(String value) The name of the control panel.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnControlPanel

protected CfnControlPanel(software.amazon.jsii.JsiiObjectRef objRef)

CfnControlPanel

protected CfnControlPanel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnControlPanel

@Stability(value=Stable)
public CfnControlPanel(@NotNull
                                                Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnControlPanelProps props)

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

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrControlPanelArn

@Stability(value=Stable)
 @NotNull
public String getAttrControlPanelArn()

The Amazon Resource Name (ARN) of the control panel.

getAttrDefaultControlPanel

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrDefaultControlPanel()

The boolean flag that is set to true for the default control panel in the cluster.

getAttrRoutingControlCount

@Stability(value=Stable)
 @NotNull
public Number getAttrRoutingControlCount()

The number of routing controls in the control panel.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The deployment status of control panel.

Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The value for a tag.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the control panel.

You can use any non-white space character in the name.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the control panel.

You can use any non-white space character in the name.

getClusterArn

@Stability(value=Stable)
 @Nullable
public String getClusterArn()

The Amazon Resource Name (ARN) of the cluster for the control panel.

setClusterArn

@Stability(value=Stable)
public void setClusterArn(@Nullable
                                                   String value)

The Amazon Resource Name (ARN) of the cluster for the control panel.