CfnOdbNetworkPropsMixin

class aws_cdk.mixins_preview.aws_odb.mixins.CfnOdbNetworkPropsMixin(props, *, strategy=None)

Bases: Mixin

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

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
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_odb import mixins as odb_mixins

cfn_odb_network_props_mixin = odb_mixins.CfnOdbNetworkPropsMixin(odb_mixins.CfnOdbNetworkMixinProps(
    availability_zone="availabilityZone",
    availability_zone_id="availabilityZoneId",
    backup_subnet_cidr="backupSubnetCidr",
    client_subnet_cidr="clientSubnetCidr",
    custom_domain_name="customDomainName",
    default_dns_prefix="defaultDnsPrefix",
    delete_associated_resources=False,
    display_name="displayName",
    s3_access="s3Access",
    s3_policy_document="s3PolicyDocument",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    zero_etl_access="zeroEtlAccess"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ODB::OdbNetwork.

Parameters:

props (Union[CfnOdbNetworkMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['availabilityZone', 'availabilityZoneId', 'backupSubnetCidr', 'clientSubnetCidr', 'customDomainName', 'defaultDnsPrefix', 'deleteAssociatedResources', 'displayName', 's3Access', 's3PolicyDocument', 'tags', 'zeroEtlAccess']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ManagedS3BackupAccessProperty

class CfnOdbNetworkPropsMixin.ManagedS3BackupAccessProperty(*, ipv4_addresses=None, status=None)

Bases: object

The configuration for managed Amazon S3 backup access from the ODB network.

Parameters:

ipv4_addresses (Optional[Sequence[str]]) – The IPv4 addresses for the managed Amazon S3 backup access.
status (Optional[str]) – The status of the managed Amazon S3 backup access.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-manageds3backupaccess.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_odb import mixins as odb_mixins

managed_s3_backup_access_property = odb_mixins.CfnOdbNetworkPropsMixin.ManagedS3BackupAccessProperty(
    ipv4_addresses=["ipv4Addresses"],
    status="status"
)

Attributes

ipv4_addresses

The IPv4 addresses for the managed Amazon S3 backup access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-manageds3backupaccess.html#cfn-odb-odbnetwork-manageds3backupaccess-ipv4addresses

status

The status of the managed Amazon S3 backup access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-manageds3backupaccess.html#cfn-odb-odbnetwork-manageds3backupaccess-status

ManagedServicesProperty

class CfnOdbNetworkPropsMixin.ManagedServicesProperty(*, managed_s3_backup_access=None, managed_services_ipv4_cidrs=None, resource_gateway_arn=None, s3_access=None, service_network_arn=None, service_network_endpoint=None, zero_etl_access=None)

Bases: object

The managed services configuration for the ODB network.

Parameters:

managed_s3_backup_access (Union[IResolvable, ManagedS3BackupAccessProperty, Dict[str, Any], None]) – The managed Amazon S3 backup access configuration.
managed_services_ipv4_cidrs (Optional[Sequence[str]]) – The IPv4 CIDR blocks for the managed services.
resource_gateway_arn (Optional[str]) – The Amazon Resource Name (ARN) of the resource gateway.
s3_access (Union[IResolvable, S3AccessProperty, Dict[str, Any], None]) – The Amazon S3 access configuration.
service_network_arn (Optional[str]) – The Amazon Resource Name (ARN) of the service network.
service_network_endpoint (Union[IResolvable, ServiceNetworkEndpointProperty, Dict[str, Any], None]) – The service network endpoint configuration.
zero_etl_access (Union[IResolvable, ZeroEtlAccessProperty, Dict[str, Any], None]) – The Zero-ETL access configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_odb import mixins as odb_mixins

managed_services_property = odb_mixins.CfnOdbNetworkPropsMixin.ManagedServicesProperty(
    managed_s3_backup_access=odb_mixins.CfnOdbNetworkPropsMixin.ManagedS3BackupAccessProperty(
        ipv4_addresses=["ipv4Addresses"],
        status="status"
    ),
    managed_services_ipv4_cidrs=["managedServicesIpv4Cidrs"],
    resource_gateway_arn="resourceGatewayArn",
    s3_access=odb_mixins.CfnOdbNetworkPropsMixin.S3AccessProperty(
        domain_name="domainName",
        ipv4_addresses=["ipv4Addresses"],
        s3_policy_document="s3PolicyDocument",
        status="status"
    ),
    service_network_arn="serviceNetworkArn",
    service_network_endpoint=odb_mixins.CfnOdbNetworkPropsMixin.ServiceNetworkEndpointProperty(
        vpc_endpoint_id="vpcEndpointId",
        vpc_endpoint_type="vpcEndpointType"
    ),
    zero_etl_access=odb_mixins.CfnOdbNetworkPropsMixin.ZeroEtlAccessProperty(
        cidr="cidr",
        status="status"
    )
)

Attributes

managed_s3_backup_access

The managed Amazon S3 backup access configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-manageds3backupaccess

managed_services_ipv4_cidrs

The IPv4 CIDR blocks for the managed services.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-managedservicesipv4cidrs

resource_gateway_arn

The Amazon Resource Name (ARN) of the resource gateway.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-resourcegatewayarn

s3_access

The Amazon S3 access configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-s3access

service_network_arn

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-servicenetworkarn

service_network_endpoint

The service network endpoint configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-servicenetworkendpoint

zero_etl_access

The Zero-ETL access configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-managedservices.html#cfn-odb-odbnetwork-managedservices-zeroetlaccess

S3AccessProperty

class CfnOdbNetworkPropsMixin.S3AccessProperty(*, domain_name=None, ipv4_addresses=None, s3_policy_document=None, status=None)

Bases: object

The configuration for Amazon S3 access from the ODB network.

Parameters:

domain_name (Optional[str]) – The domain name for the Amazon S3 access.
ipv4_addresses (Optional[Sequence[str]]) – The IPv4 addresses for the Amazon S3 access.
s3_policy_document (Optional[str]) – The endpoint policy for the Amazon S3 access.
status (Optional[str]) – The status of the Amazon S3 access.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_odb import mixins as odb_mixins

s3_access_property = odb_mixins.CfnOdbNetworkPropsMixin.S3AccessProperty(
    domain_name="domainName",
    ipv4_addresses=["ipv4Addresses"],
    s3_policy_document="s3PolicyDocument",
    status="status"
)

Attributes

domain_name

The domain name for the Amazon S3 access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html#cfn-odb-odbnetwork-s3access-domainname

ipv4_addresses

The IPv4 addresses for the Amazon S3 access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html#cfn-odb-odbnetwork-s3access-ipv4addresses

s3_policy_document

The endpoint policy for the Amazon S3 access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html#cfn-odb-odbnetwork-s3access-s3policydocument

status

The status of the Amazon S3 access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-s3access.html#cfn-odb-odbnetwork-s3access-status

ServiceNetworkEndpointProperty

class CfnOdbNetworkPropsMixin.ServiceNetworkEndpointProperty(*, vpc_endpoint_id=None, vpc_endpoint_type=None)

Bases: object

The configuration for a service network endpoint.

Parameters:

vpc_endpoint_id (Optional[str]) – The identifier of the VPC endpoint.
vpc_endpoint_type (Optional[str]) – The type of the VPC endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-servicenetworkendpoint.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_odb import mixins as odb_mixins

service_network_endpoint_property = odb_mixins.CfnOdbNetworkPropsMixin.ServiceNetworkEndpointProperty(
    vpc_endpoint_id="vpcEndpointId",
    vpc_endpoint_type="vpcEndpointType"
)

Attributes

vpc_endpoint_id

The identifier of the VPC endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-servicenetworkendpoint.html#cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointid

vpc_endpoint_type

The type of the VPC endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-servicenetworkendpoint.html#cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointtype

ZeroEtlAccessProperty

class CfnOdbNetworkPropsMixin.ZeroEtlAccessProperty(*, cidr=None, status=None)

Bases: object

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

Parameters:

cidr (Optional[str]) – The CIDR block for the Zero-ETL access.
status (Optional[str]) – The status of the Zero-ETL access.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-zeroetlaccess.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_odb import mixins as odb_mixins

zero_etl_access_property = odb_mixins.CfnOdbNetworkPropsMixin.ZeroEtlAccessProperty(
    cidr="cidr",
    status="status"
)

Attributes

cidr

The CIDR block for the Zero-ETL access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-zeroetlaccess.html#cfn-odb-odbnetwork-zeroetlaccess-cidr

status

The status of the Zero-ETL access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-odb-odbnetwork-zeroetlaccess.html#cfn-odb-odbnetwork-zeroetlaccess-status