CfnEndpointAccessPropsMixin

class aws_cdk.mixins_preview.aws_redshift.mixins.CfnEndpointAccessPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a Redshift-managed VPC endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html

CloudformationResource:

AWS::Redshift::EndpointAccess

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_redshift import mixins as redshift_mixins

cfn_endpoint_access_props_mixin = redshift_mixins.CfnEndpointAccessPropsMixin(redshift_mixins.CfnEndpointAccessMixinProps(
    cluster_identifier="clusterIdentifier",
    endpoint_name="endpointName",
    resource_owner="resourceOwner",
    subnet_group_name="subnetGroupName",
    vpc_security_group_ids=["vpcSecurityGroupIds"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Redshift::EndpointAccess.

Parameters:

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 = ['clusterIdentifier', 'endpointName', 'resourceOwner', 'subnetGroupName', 'vpcSecurityGroupIds']

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

NetworkInterfaceProperty

class CfnEndpointAccessPropsMixin.NetworkInterfaceProperty(*, availability_zone=None, network_interface_id=None, private_ip_address=None, subnet_id=None)

Bases: object

Describes a network interface.

Parameters:
  • availability_zone (Optional[str]) – The Availability Zone.

  • network_interface_id (Optional[str]) – The network interface identifier.

  • private_ip_address (Optional[str]) – The IPv4 address of the network interface within the subnet.

  • subnet_id (Optional[str]) – The subnet identifier.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.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_redshift import mixins as redshift_mixins

network_interface_property = redshift_mixins.CfnEndpointAccessPropsMixin.NetworkInterfaceProperty(
    availability_zone="availabilityZone",
    network_interface_id="networkInterfaceId",
    private_ip_address="privateIpAddress",
    subnet_id="subnetId"
)

Attributes

availability_zone

The Availability Zone.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html#cfn-redshift-endpointaccess-networkinterface-availabilityzone

network_interface_id

The network interface identifier.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html#cfn-redshift-endpointaccess-networkinterface-networkinterfaceid

private_ip_address

The IPv4 address of the network interface within the subnet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html#cfn-redshift-endpointaccess-networkinterface-privateipaddress

subnet_id

The subnet identifier.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html#cfn-redshift-endpointaccess-networkinterface-subnetid

VpcEndpointProperty

class CfnEndpointAccessPropsMixin.VpcEndpointProperty(*, network_interfaces=None, vpc_endpoint_id=None, vpc_id=None)

Bases: object

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

Parameters:
  • network_interfaces (Union[IResolvable, Sequence[Union[IResolvable, NetworkInterfaceProperty, Dict[str, Any]]], None]) – One or more network interfaces of the endpoint. Also known as an interface endpoint.

  • vpc_endpoint_id (Optional[str]) – The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

  • vpc_id (Optional[str]) – The VPC identifier that the endpoint is associated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcendpoint.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_redshift import mixins as redshift_mixins

vpc_endpoint_property = redshift_mixins.CfnEndpointAccessPropsMixin.VpcEndpointProperty(
    network_interfaces=[redshift_mixins.CfnEndpointAccessPropsMixin.NetworkInterfaceProperty(
        availability_zone="availabilityZone",
        network_interface_id="networkInterfaceId",
        private_ip_address="privateIpAddress",
        subnet_id="subnetId"
    )],
    vpc_endpoint_id="vpcEndpointId",
    vpc_id="vpcId"
)

Attributes

network_interfaces

One or more network interfaces of the endpoint.

Also known as an interface endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcendpoint.html#cfn-redshift-endpointaccess-vpcendpoint-networkinterfaces

vpc_endpoint_id

The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcendpoint.html#cfn-redshift-endpointaccess-vpcendpoint-vpcendpointid

vpc_id

The VPC identifier that the endpoint is associated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcendpoint.html#cfn-redshift-endpointaccess-vpcendpoint-vpcid

VpcSecurityGroupProperty

class CfnEndpointAccessPropsMixin.VpcSecurityGroupProperty(*, status=None, vpc_security_group_id=None)

Bases: object

The security groups associated with the endpoint.

Parameters:
  • status (Optional[str]) – The status of the endpoint.

  • vpc_security_group_id (Optional[str]) – The identifier of the VPC security group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcsecuritygroup.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_redshift import mixins as redshift_mixins

vpc_security_group_property = redshift_mixins.CfnEndpointAccessPropsMixin.VpcSecurityGroupProperty(
    status="status",
    vpc_security_group_id="vpcSecurityGroupId"
)

Attributes

status

The status of the endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcsecuritygroup.html#cfn-redshift-endpointaccess-vpcsecuritygroup-status

vpc_security_group_id

The identifier of the VPC security group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-vpcsecuritygroup.html#cfn-redshift-endpointaccess-vpcsecuritygroup-vpcsecuritygroupid