Package software.amazon.awscdk.services.odb

Interface CfnOdbNetworkProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOdbNetworkProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-16T11:43:19.108Z")
@Stability(Stable)
public interface CfnOdbNetworkProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnOdbNetwork.

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.*;
 CfnOdbNetworkProps cfnOdbNetworkProps = CfnOdbNetworkProps.builder()
         .availabilityZone("availabilityZone")
         .availabilityZoneId("availabilityZoneId")
         .backupSubnetCidr("backupSubnetCidr")
         .clientSubnetCidr("clientSubnetCidr")
         .defaultDnsPrefix("defaultDnsPrefix")
         .deleteAssociatedResources(false)
         .displayName("displayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnOdbNetworkProps.Builder	A builder for CfnOdbNetworkProps
static final class	CfnOdbNetworkProps.Jsii$Proxy	An implementation for CfnOdbNetworkProps

Method Summary

Modifier and Type	Method	Description
static CfnOdbNetworkProps.Builder	builder()
default String	getAvailabilityZone()	The Availability Zone (AZ) where the ODB network is located.
default String	getAvailabilityZoneId()	The AZ ID of the AZ where the ODB network is located.
default String	getBackupSubnetCidr()	The CIDR range of the backup subnet in the ODB network.
default String	getClientSubnetCidr()	The CIDR range of the client subnet in the ODB network.
default String	getDefaultDnsPrefix()	The DNS prefix to the default DNS domain name.
default Object	getDeleteAssociatedResources()	Specifies whether to delete associated OCI networking resources along with the ODB network.
default String	getDisplayName()	The user-friendly name of the ODB network.
default List<CfnTag>	getTags()	Tags to assign to the Odb Network.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityZone

@Stability(Stable)
@Nullable
default String getAvailabilityZone()

The Availability Zone (AZ) where the ODB network is located.

Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-availabilityzone

getAvailabilityZoneId

@Stability(Stable)
@Nullable
default String getAvailabilityZoneId()

The AZ ID of the AZ where the ODB network is located.

Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-availabilityzoneid

getBackupSubnetCidr

@Stability(Stable)
@Nullable
default String getBackupSubnetCidr()

The CIDR range of the backup subnet in the ODB network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-backupsubnetcidr

getClientSubnetCidr

@Stability(Stable)
@Nullable
default String getClientSubnetCidr()

The CIDR range of the client subnet in the ODB network.

Required when creating an ODB network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-clientsubnetcidr

getDefaultDnsPrefix

@Stability(Stable)
@Nullable
default String getDefaultDnsPrefix()

The DNS prefix to the default DNS domain name.

The default DNS domain name is oraclevcn.com.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-defaultdnsprefix

getDeleteAssociatedResources

@Stability(Stable)
@Nullable
default Object getDeleteAssociatedResources()

Specifies whether to delete associated OCI networking resources along with the ODB network.

Required when creating an ODB network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-deleteassociatedresources

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The user-friendly name of the ODB network.

Required when creating an ODB network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-displayname

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags to assign to the Odb Network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-odb-odbnetwork.html#cfn-odb-odbnetwork-tags

builder

@Stability(Stable)
static CfnOdbNetworkProps.Builder builder()

Returns:

a CfnOdbNetworkProps.Builder of CfnOdbNetworkProps