Package software.amazon.awscdk.services.odb

Class CfnOdbPeeringConnection

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.odb.CfnOdbPeeringConnection
All Implemented Interfaces:
IInspectable, ITaggableV2, IOdbPeeringConnectionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-09-25T11:29:12.691Z") @Stability(Stable) public class CfnOdbPeeringConnection extends CfnResource implements IInspectable, IOdbPeeringConnectionRef, ITaggableV2
Creates a peering connection between an ODB network and either another ODB network or a customer-owned VPC.

A peering connection enables private connectivity between the networks for application-tier communication.

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.odb.*;
 CfnOdbPeeringConnection cfnOdbPeeringConnection = CfnOdbPeeringConnection.Builder.create(this, "MyCfnOdbPeeringConnection")
         .displayName("displayName")
         .odbNetworkId("odbNetworkId")
         .peerNetworkId("peerNetworkId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnOdbPeeringConnection

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

    • CfnOdbPeeringConnection

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

    • CfnOdbPeeringConnection

      @Stability(Stable) public CfnOdbPeeringConnection(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnOdbPeeringConnectionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnOdbPeeringConnection

      @Stability(Stable) public CfnOdbPeeringConnection(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrOdbNetworkArn

      @Stability(Stable) @NotNull public String getAttrOdbNetworkArn()
      The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.

    • getAttrOdbPeeringConnectionArn

      @Stability(Stable) @NotNull public String getAttrOdbPeeringConnectionArn()
      The Amazon Resource Name (ARN) of the ODB peering connection.

    • getAttrOdbPeeringConnectionId

      @Stability(Stable) @NotNull public String getAttrOdbPeeringConnectionId()
      The unique identifier of the ODB peering connection.

      A sample ID is odbpcx-abcdefgh12345678 .

    • getAttrPeerNetworkArn

      @Stability(Stable) @NotNull public String getAttrPeerNetworkArn()
      The Amazon Resource Name (ARN) of the peer network.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getOdbPeeringConnectionRef

      @Stability(Stable) @NotNull public OdbPeeringConnectionReference getOdbPeeringConnectionRef()
      A reference to a OdbPeeringConnection resource.
      Specified by:
      getOdbPeeringConnectionRef in interface IOdbPeeringConnectionRef

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The display name of the ODB peering connection.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The display name of the ODB peering connection.

    • getOdbNetworkId

      @Stability(Stable) @Nullable public String getOdbNetworkId()
      The unique identifier of the ODB network.

    • setOdbNetworkId

      @Stability(Stable) public void setOdbNetworkId(@Nullable String value)
      The unique identifier of the ODB network.

    • getPeerNetworkId

      @Stability(Stable) @Nullable public String getPeerNetworkId()
      The unique identifier of the peer network.

    • setPeerNetworkId

      @Stability(Stable) public void setPeerNetworkId(@Nullable String value)
      The unique identifier of the peer network.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags to assign to the Odb peering connection.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags to assign to the Odb peering connection.