software.amazon.awscdk.services.route53recoverycontrol

Class CfnControlPanel

java.lang.Object

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:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:25.224Z")
public class CfnControlPanel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Route53RecoveryControl::ControlPanel`.

Creates a new control panel in Amazon Route 53 Application Recovery Controller. 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 from one AWS Region (cell) to another.

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 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 java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnControlPanel(Construct scope, java.lang.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
java.lang.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.
java.lang.Number	getAttrRoutingControlCount() The number of routing controls in the control panel.
java.lang.String	getAttrStatus() The deployment status of control panel.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getClusterArn() The Amazon Resource Name (ARN) of the cluster for the control panel.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setClusterArn(java.lang.String value) The Amazon Resource Name (ARN) of the cluster for the control panel.
void	setName(java.lang.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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnControlPanel(Construct scope,
                       java.lang.String id,
                       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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrControlPanelArn

public java.lang.String getAttrControlPanelArn()

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

getAttrDefaultControlPanel

public IResolvable getAttrDefaultControlPanel()

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

getAttrRoutingControlCount

public java.lang.Number getAttrRoutingControlCount()

The number of routing controls in the control panel.

getAttrStatus

public java.lang.String getAttrStatus()

The deployment status of control panel.

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The value for a tag.

getName

public java.lang.String getName()

The name of the control panel.

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

setName

public void setName(java.lang.String value)

The name of the control panel.

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

getClusterArn

public java.lang.String getClusterArn()

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

setClusterArn

public void setClusterArn(java.lang.String value)

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