Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.025Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnControlPanel

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

    • CfnControlPanel

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

    • CfnControlPanel

      @Stability(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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrControlPanelArn()
      The Amazon Resource Name (ARN) of the control panel.

    • getAttrDefaultControlPanel

      @Stability(Stable) @NotNull public IResolvable getAttrDefaultControlPanel()
      The boolean flag that is set to true for the default control panel in the cluster.

    • getAttrRoutingControlCount

      @Stability(Stable) @NotNull public Number getAttrRoutingControlCount()
      The number of routing controls in the control panel.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The deployment status of control panel.

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The value for a tag.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the control panel.

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

    • setName

      @Stability(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(Stable) @Nullable public String getClusterArn()
      The Amazon Resource Name (ARN) of the cluster for the control panel.

    • setClusterArn

      @Stability(Stable) public void setClusterArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the cluster for the control panel.