Class CfnOdbNetwork

The AWS::ODB::OdbNetwork resource creates an ODB network.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnOdbNetwork

Implements

IInspectable

IOdbNetworkRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ODB

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnOdbNetwork : CfnResource, IInspectable, IOdbNetworkRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnOdbNetwork Inherits CfnResource Implements IInspectable, IOdbNetworkRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ODB;

             var cfnOdbNetwork = new CfnOdbNetwork(this, "MyCfnOdbNetwork", new CfnOdbNetworkProps {
                 AvailabilityZone = "availabilityZone",
                 AvailabilityZoneId = "availabilityZoneId",
                 BackupSubnetCidr = "backupSubnetCidr",
                 ClientSubnetCidr = "clientSubnetCidr",
                 CustomDomainName = "customDomainName",
                 DefaultDnsPrefix = "defaultDnsPrefix",
                 DeleteAssociatedResources = false,
                 DisplayName = "displayName",
                 S3Access = "s3Access",
                 S3PolicyDocument = "s3PolicyDocument",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 ZeroEtlAccess = "zeroEtlAccess"
             });

Synopsis

Constructors

CfnOdbNetwork(Construct, string, ICfnOdbNetworkProps?)

Create a new AWS::ODB::OdbNetwork.

Properties

AttrManagedServices	The managed services configuration for the ODB network.
AttrOciNetworkAnchorId	The unique identifier of the OCI network anchor for the ODB network.
AttrOciResourceAnchorName	The name of the OCI resource anchor that's associated with the ODB network.
AttrOciVcnUrl	The URL for the VCN that's associated with the ODB network.
AttrOdbNetworkArn	The Amazon Resource Name (ARN) of the ODB network.
AttrOdbNetworkId	The unique identifier of the ODB network.
AvailabilityZone	The Availability Zone (AZ) where the ODB network is located.
AvailabilityZoneId	The AZ ID of the AZ where the ODB network is located.
BackupSubnetCidr	The CIDR range of the backup subnet in the ODB network.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The AWS::ODB::OdbNetwork resource creates an ODB network.
ClientSubnetCidr	The CIDR range of the client subnet in the ODB network.
CustomDomainName	The domain name for the resources in the ODB network.
DefaultDnsPrefix	The DNS prefix to the default DNS domain name.
DeleteAssociatedResources	Specifies whether to delete associated OCI networking resources along with the ODB network.
DisplayName	The user-friendly name of the ODB network.
OdbNetworkRef	A reference to a OdbNetwork resource.
S3Access	The configuration for Amazon S3 access from the ODB network.
S3PolicyDocument	Specifies the endpoint policy for Amazon S3 access from the ODB network.
Tags	Tags to assign to the Odb Network.
ZeroEtlAccess	The configuration for Zero-ETL access from the ODB network.

Methods

ArnForOdbNetwork(IOdbNetworkRef)	The AWS::ODB::OdbNetwork resource creates an ODB network.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnOdbNetwork(object)	Checks whether the given object is a CfnOdbNetwork.
RenderProperties(IDictionary<string, object>)	The AWS::ODB::OdbNetwork resource creates an ODB network.

Constructors

CfnOdbNetwork(Construct, string, ICfnOdbNetworkProps?)

Create a new AWS::ODB::OdbNetwork.

public CfnOdbNetwork(Construct scope, string id, ICfnOdbNetworkProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnOdbNetworkProps

Resource properties.

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

Properties

AttrManagedServices

The managed services configuration for the ODB network.

public virtual IResolvable AttrManagedServices { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: ManagedServices

AttrOciNetworkAnchorId

The unique identifier of the OCI network anchor for the ODB network.

public virtual string AttrOciNetworkAnchorId { get; }

Property Value

string

Remarks

CloudformationAttribute: OciNetworkAnchorId

AttrOciResourceAnchorName

The name of the OCI resource anchor that's associated with the ODB network.

public virtual string AttrOciResourceAnchorName { get; }

Property Value

string

Remarks

CloudformationAttribute: OciResourceAnchorName

AttrOciVcnUrl

The URL for the VCN that's associated with the ODB network.

public virtual string AttrOciVcnUrl { get; }

Property Value

string

Remarks

CloudformationAttribute: OciVcnUrl

AttrOdbNetworkArn

The Amazon Resource Name (ARN) of the ODB network.

public virtual string AttrOdbNetworkArn { get; }

Property Value

string

Remarks

CloudformationAttribute: OdbNetworkArn

AttrOdbNetworkId

The unique identifier of the ODB network.

public virtual string AttrOdbNetworkId { get; }

Property Value

string

Remarks

CloudformationAttribute: OdbNetworkId

AvailabilityZone

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

public virtual string? AvailabilityZone { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

AvailabilityZoneId

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

public virtual string? AvailabilityZoneId { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

BackupSubnetCidr

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

public virtual string? BackupSubnetCidr { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::ODB::OdbNetwork resource creates an ODB network.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

ClientSubnetCidr

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

public virtual string? ClientSubnetCidr { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

CustomDomainName

The domain name for the resources in the ODB network.

public virtual string? CustomDomainName { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

DefaultDnsPrefix

The DNS prefix to the default DNS domain name.

public virtual string? DefaultDnsPrefix { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

DeleteAssociatedResources

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

public virtual object? DeleteAssociatedResources { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

DisplayName

The user-friendly name of the ODB network.

public virtual string? DisplayName { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

OdbNetworkRef

A reference to a OdbNetwork resource.

public virtual IOdbNetworkReference OdbNetworkRef { get; }

Property Value

IOdbNetworkReference

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

S3Access

The configuration for Amazon S3 access from the ODB network.

public virtual string? S3Access { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

S3PolicyDocument

Specifies the endpoint policy for Amazon S3 access from the ODB network.

public virtual string? S3PolicyDocument { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

Tags

Tags to assign to the Odb Network.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

ZeroEtlAccess

The configuration for Zero-ETL access from the ODB network.

public virtual string? ZeroEtlAccess { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

Methods

ArnForOdbNetwork(IOdbNetworkRef)

The AWS::ODB::OdbNetwork resource creates an ODB network.

public static string ArnForOdbNetwork(IOdbNetworkRef resource)

Parameters

resource IOdbNetworkRef

Returns

string

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ODB;

             var cfnOdbNetwork = new CfnOdbNetwork(this, "MyCfnOdbNetwork", new CfnOdbNetworkProps {
                 AvailabilityZone = "availabilityZone",
                 AvailabilityZoneId = "availabilityZoneId",
                 BackupSubnetCidr = "backupSubnetCidr",
                 ClientSubnetCidr = "clientSubnetCidr",
                 CustomDomainName = "customDomainName",
                 DefaultDnsPrefix = "defaultDnsPrefix",
                 DeleteAssociatedResources = false,
                 DisplayName = "displayName",
                 S3Access = "s3Access",
                 S3PolicyDocument = "s3PolicyDocument",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 ZeroEtlAccess = "zeroEtlAccess"
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

IsCfnOdbNetwork(object)

Checks whether the given object is a CfnOdbNetwork.

public static bool IsCfnOdbNetwork(object x)

Parameters

x object

Returns

bool

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::ODB::OdbNetwork resource creates an ODB network.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

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

CloudformationResource: AWS::ODB::OdbNetwork

ExampleMetadata: fixture=_generated

Implements

IInspectable

IOdbNetworkRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2