Package software.amazon.awscdk.services.odb

Class CfnOdbNetwork

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.CfnOdbNetwork
All Implemented Interfaces:
IInspectable, ITaggableV2, IOdbNetworkRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:44.174Z") @Stability(Stable) public class CfnOdbNetwork extends CfnResource implements IInspectable, IOdbNetworkRef, ITaggableV2
The AWS::ODB::OdbNetwork resource creates an ODB network.

An ODB network provides the networking foundation for Oracle Database resources.

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.*;
 CfnOdbNetwork cfnOdbNetwork = CfnOdbNetwork.Builder.create(this, "MyCfnOdbNetwork")
         .availabilityZone("availabilityZone")
         .availabilityZoneId("availabilityZoneId")
         .backupSubnetCidr("backupSubnetCidr")
         .clientSubnetCidr("clientSubnetCidr")
         .customDomainName("customDomainName")
         .defaultDnsPrefix("defaultDnsPrefix")
         .deleteAssociatedResources(false)
         .displayName("displayName")
         .s3Access("s3Access")
         .s3PolicyDocument("s3PolicyDocument")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .zeroEtlAccess("zeroEtlAccess")
         .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

    • CfnOdbNetwork

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

    • CfnOdbNetwork

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

    • CfnOdbNetwork

      @Stability(Stable) public CfnOdbNetwork(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnOdbNetworkProps 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.

    • CfnOdbNetwork

      @Stability(Stable) public CfnOdbNetwork(@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.

    • getAttrManagedServices

      @Stability(Stable) @NotNull public IResolvable getAttrManagedServices()
      The managed services configuration for the ODB network.

    • getAttrOciNetworkAnchorId

      @Stability(Stable) @NotNull public String getAttrOciNetworkAnchorId()
      The unique identifier of the OCI network anchor for the ODB network.

    • getAttrOciResourceAnchorName

      @Stability(Stable) @NotNull public String getAttrOciResourceAnchorName()
      The name of the OCI resource anchor that's associated with the ODB network.

    • getAttrOciVcnUrl

      @Stability(Stable) @NotNull public String getAttrOciVcnUrl()
      The URL for the VCN that's associated with the ODB network.

    • getAttrOdbNetworkArn

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

    • getAttrOdbNetworkId

      @Stability(Stable) @NotNull public String getAttrOdbNetworkId()
      The unique identifier of the ODB 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

    • getOdbNetworkRef

      @Stability(Stable) @NotNull public OdbNetworkReference getOdbNetworkRef()
      A reference to a OdbNetwork resource.
      Specified by:
      getOdbNetworkRef in interface IOdbNetworkRef

    • getAvailabilityZone

      @Stability(Stable) @Nullable public String getAvailabilityZone()
      The Availability Zone (AZ) where the ODB network is located.

    • setAvailabilityZone

      @Stability(Stable) public void setAvailabilityZone(@Nullable String value)
      The Availability Zone (AZ) where the ODB network is located.

    • getAvailabilityZoneId

      @Stability(Stable) @Nullable public String getAvailabilityZoneId()
      The AZ ID of the AZ where the ODB network is located.

    • setAvailabilityZoneId

      @Stability(Stable) public void setAvailabilityZoneId(@Nullable String value)
      The AZ ID of the AZ where the ODB network is located.

    • getBackupSubnetCidr

      @Stability(Stable) @Nullable public String getBackupSubnetCidr()
      The CIDR range of the backup subnet in the ODB network.

    • setBackupSubnetCidr

      @Stability(Stable) public void setBackupSubnetCidr(@Nullable String value)
      The CIDR range of the backup subnet in the ODB network.

    • getClientSubnetCidr

      @Stability(Stable) @Nullable public String getClientSubnetCidr()
      The CIDR range of the client subnet in the ODB network.

    • setClientSubnetCidr

      @Stability(Stable) public void setClientSubnetCidr(@Nullable String value)
      The CIDR range of the client subnet in the ODB network.

    • getCustomDomainName

      @Stability(Stable) @Nullable public String getCustomDomainName()
      The domain name for the resources in the ODB network.

    • setCustomDomainName

      @Stability(Stable) public void setCustomDomainName(@Nullable String value)
      The domain name for the resources in the ODB network.

    • getDefaultDnsPrefix

      @Stability(Stable) @Nullable public String getDefaultDnsPrefix()
      The DNS prefix to the default DNS domain name.

    • setDefaultDnsPrefix

      @Stability(Stable) public void setDefaultDnsPrefix(@Nullable String value)
      The DNS prefix to the default DNS domain name.

    • getDeleteAssociatedResources

      @Stability(Stable) @Nullable public Object getDeleteAssociatedResources()
      Specifies whether to delete associated OCI networking resources along with the ODB network.

      Returns union: either Boolean or IResolvable

    • setDeleteAssociatedResources

      @Stability(Stable) public void setDeleteAssociatedResources(@Nullable Boolean value)
      Specifies whether to delete associated OCI networking resources along with the ODB network.

    • setDeleteAssociatedResources

      @Stability(Stable) public void setDeleteAssociatedResources(@Nullable IResolvable value)
      Specifies whether to delete associated OCI networking resources along with the ODB network.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The user-friendly name of the ODB network.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The user-friendly name of the ODB network.

    • getS3Access

      @Stability(Stable) @Nullable public String getS3Access()
      The configuration for Amazon S3 access from the ODB network.

    • setS3Access

      @Stability(Stable) public void setS3Access(@Nullable String value)
      The configuration for Amazon S3 access from the ODB network.

    • getS3PolicyDocument

      @Stability(Stable) @Nullable public String getS3PolicyDocument()
      Specifies the endpoint policy for Amazon S3 access from the ODB network.

    • setS3PolicyDocument

      @Stability(Stable) public void setS3PolicyDocument(@Nullable String value)
      Specifies the endpoint policy for Amazon S3 access from the ODB network.

    • getTags

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

    • setTags

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

    • getZeroEtlAccess

      @Stability(Stable) @Nullable public String getZeroEtlAccess()
      The configuration for Zero-ETL access from the ODB network.

    • setZeroEtlAccess

      @Stability(Stable) public void setZeroEtlAccess(@Nullable String value)
      The configuration for Zero-ETL access from the ODB network.