Package software.amazon.awscdk.services.route53recoverycontrol

Class CfnRoutingControl

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.CfnRoutingControl
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.026Z") @Stability(Stable) public class CfnRoutingControl extends CfnResource implements IInspectable
A CloudFormation AWS::Route53RecoveryControl::RoutingControl.

Creates a routing control in Amazon Route 53 Application Recovery Controller. Routing control states are maintained on the highly reliable cluster data plane.

To get or update the state of the routing control, you must specify a cluster endpoint, which is an endpoint URL and an AWS Region. For more information, see Code examples in the Amazon Route 53 Application Recovery Controller Developer Guide.

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.*;
 CfnRoutingControl cfnRoutingControl = CfnRoutingControl.Builder.create(this, "MyCfnRoutingControl")
         .name("name")
         // the properties below are optional
         .clusterArn("clusterArn")
         .controlPanelArn("controlPanelArn")
         .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

    • CfnRoutingControl

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

    • CfnRoutingControl

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

    • CfnRoutingControl

      @Stability(Stable) public CfnRoutingControl(@NotNull Construct scope, @NotNull String id, @NotNull CfnRoutingControlProps props)
      Create a new AWS::Route53RecoveryControl::RoutingControl.

      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.

    • getAttrRoutingControlArn

      @Stability(Stable) @NotNull public String getAttrRoutingControlArn()
      The Amazon Resource Name (ARN) of the routing control.

    • getAttrStatus

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

      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

    • getName

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

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

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the routing control.

      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 that hosts the routing control.

    • setClusterArn

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

    • getControlPanelArn

      @Stability(Stable) @Nullable public String getControlPanelArn()
      The Amazon Resource Name (ARN) of the control panel that includes the routing control.

    • setControlPanelArn

      @Stability(Stable) public void setControlPanelArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the control panel that includes the routing control.