CfnVerifiedAccessEndpointPropsMixin

class aws_cdk.mixins_preview.aws_ec2.mixins.CfnVerifiedAccessEndpointPropsMixin(props, *, strategy=None)

Bases: Mixin

An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to.

It must be attached to an AWS Verified Access group. An AWS Verified Access endpoint must also have an attached access policy before you attached it to a group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html
CloudformationResource:: AWS::EC2::VerifiedAccessEndpoint
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_ec2 import mixins as ec2_mixins

cfn_verified_access_endpoint_props_mixin = ec2_mixins.CfnVerifiedAccessEndpointPropsMixin(ec2_mixins.CfnVerifiedAccessEndpointMixinProps(
    application_domain="applicationDomain",
    attachment_type="attachmentType",
    cidr_options=ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.CidrOptionsProperty(
        cidr="cidr",
        port_ranges=[ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.PortRangeProperty(
            from_port=123,
            to_port=123
        )],
        protocol="protocol",
        subnet_ids=["subnetIds"]
    ),
    description="description",
    domain_certificate_arn="domainCertificateArn",
    endpoint_domain_prefix="endpointDomainPrefix",
    endpoint_type="endpointType",
    load_balancer_options=ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.LoadBalancerOptionsProperty(
        load_balancer_arn="loadBalancerArn",
        port=123,
        port_ranges=[ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.PortRangeProperty(
            from_port=123,
            to_port=123
        )],
        protocol="protocol",
        subnet_ids=["subnetIds"]
    ),
    network_interface_options=ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.NetworkInterfaceOptionsProperty(
        network_interface_id="networkInterfaceId",
        port=123,
        port_ranges=[ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.PortRangeProperty(
            from_port=123,
            to_port=123
        )],
        protocol="protocol"
    ),
    policy_document="policyDocument",
    policy_enabled=False,
    rds_options=ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.RdsOptionsProperty(
        port=123,
        protocol="protocol",
        rds_db_cluster_arn="rdsDbClusterArn",
        rds_db_instance_arn="rdsDbInstanceArn",
        rds_db_proxy_arn="rdsDbProxyArn",
        rds_endpoint="rdsEndpoint",
        subnet_ids=["subnetIds"]
    ),
    security_group_ids=["securityGroupIds"],
    sse_specification=ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.SseSpecificationProperty(
        customer_managed_key_enabled=False,
        kms_key_arn="kmsKeyArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    verified_access_group_id="verifiedAccessGroupId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EC2::VerifiedAccessEndpoint.

Parameters:

props (Union[CfnVerifiedAccessEndpointMixinProps, 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 = ['applicationDomain', 'attachmentType', 'cidrOptions', 'description', 'domainCertificateArn', 'endpointDomainPrefix', 'endpointType', 'loadBalancerOptions', 'networkInterfaceOptions', 'policyDocument', 'policyEnabled', 'rdsOptions', 'securityGroupIds', 'sseSpecification', 'tags', 'verifiedAccessGroupId']

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

CidrOptionsProperty

class CfnVerifiedAccessEndpointPropsMixin.CidrOptionsProperty(*, cidr=None, port_ranges=None, protocol=None, subnet_ids=None)

Bases: object

Describes the CIDR options for a Verified Access endpoint.

Parameters:

cidr (Optional[str]) – The CIDR.
port_ranges (Union[IResolvable, Sequence[Union[IResolvable, PortRangeProperty, Dict[str, Any]]], None]) – The port ranges.
protocol (Optional[str]) – The protocol.
subnet_ids (Optional[Sequence[str]]) – The IDs of the subnets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.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_ec2 import mixins as ec2_mixins

cidr_options_property = ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.CidrOptionsProperty(
    cidr="cidr",
    port_ranges=[ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.PortRangeProperty(
        from_port=123,
        to_port=123
    )],
    protocol="protocol",
    subnet_ids=["subnetIds"]
)

Attributes

cidr

The CIDR.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.html#cfn-ec2-verifiedaccessendpoint-cidroptions-cidr

port_ranges

The port ranges.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.html#cfn-ec2-verifiedaccessendpoint-cidroptions-portranges

protocol

The protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.html#cfn-ec2-verifiedaccessendpoint-cidroptions-protocol

subnet_ids

The IDs of the subnets.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-cidroptions.html#cfn-ec2-verifiedaccessendpoint-cidroptions-subnetids

LoadBalancerOptionsProperty

class CfnVerifiedAccessEndpointPropsMixin.LoadBalancerOptionsProperty(*, load_balancer_arn=None, port=None, port_ranges=None, protocol=None, subnet_ids=None)

Bases: object

Describes the load balancer options when creating an AWS Verified Access endpoint using the load-balancer type.

Parameters:

load_balancer_arn (Optional[str]) – The ARN of the load balancer.
port (Union[int, float, None]) – The IP port number.
port_ranges (Union[IResolvable, Sequence[Union[IResolvable, PortRangeProperty, Dict[str, Any]]], None]) – The port ranges.
protocol (Optional[str]) – The IP protocol.
subnet_ids (Optional[Sequence[str]]) – The IDs of the subnets. You can specify only one subnet per Availability Zone.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.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_ec2 import mixins as ec2_mixins

load_balancer_options_property = ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.LoadBalancerOptionsProperty(
    load_balancer_arn="loadBalancerArn",
    port=123,
    port_ranges=[ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.PortRangeProperty(
        from_port=123,
        to_port=123
    )],
    protocol="protocol",
    subnet_ids=["subnetIds"]
)

Attributes

load_balancer_arn

The ARN of the load balancer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-loadbalancerarn

port

The IP port number.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-port

port_ranges

The port ranges.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-portranges

protocol

The IP protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-protocol

subnet_ids

The IDs of the subnets.

You can specify only one subnet per Availability Zone.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-loadbalanceroptions.html#cfn-ec2-verifiedaccessendpoint-loadbalanceroptions-subnetids

NetworkInterfaceOptionsProperty

class CfnVerifiedAccessEndpointPropsMixin.NetworkInterfaceOptionsProperty(*, network_interface_id=None, port=None, port_ranges=None, protocol=None)

Bases: object

Describes the network interface options when creating an AWS Verified Access endpoint using the network-interface type.

Parameters:

network_interface_id (Optional[str]) – The ID of the network interface.
port (Union[int, float, None]) – The IP port number.
port_ranges (Union[IResolvable, Sequence[Union[IResolvable, PortRangeProperty, Dict[str, Any]]], None]) – The port ranges.
protocol (Optional[str]) – The IP protocol.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.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_ec2 import mixins as ec2_mixins

network_interface_options_property = ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.NetworkInterfaceOptionsProperty(
    network_interface_id="networkInterfaceId",
    port=123,
    port_ranges=[ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.PortRangeProperty(
        from_port=123,
        to_port=123
    )],
    protocol="protocol"
)

Attributes

network_interface_id

The ID of the network interface.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-networkinterfaceid

port

The IP port number.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-port

port_ranges

The port ranges.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-portranges

protocol

The IP protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-networkinterfaceoptions.html#cfn-ec2-verifiedaccessendpoint-networkinterfaceoptions-protocol

PortRangeProperty

class CfnVerifiedAccessEndpointPropsMixin.PortRangeProperty(*, from_port=None, to_port=None)

Bases: object

Describes the port range for a Verified Access endpoint.

Parameters:

from_port (Union[int, float, None]) – The start of the port range.
to_port (Union[int, float, None]) – The end of the port range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-portrange.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_ec2 import mixins as ec2_mixins

port_range_property = ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.PortRangeProperty(
    from_port=123,
    to_port=123
)

Attributes

from_port

The start of the port range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-portrange.html#cfn-ec2-verifiedaccessendpoint-portrange-fromport

to_port

The end of the port range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-portrange.html#cfn-ec2-verifiedaccessendpoint-portrange-toport

RdsOptionsProperty

class CfnVerifiedAccessEndpointPropsMixin.RdsOptionsProperty(*, port=None, protocol=None, rds_db_cluster_arn=None, rds_db_instance_arn=None, rds_db_proxy_arn=None, rds_endpoint=None, subnet_ids=None)

Bases: object

Describes the RDS options for a Verified Access endpoint.

Parameters:

port (Union[int, float, None]) – The port.
protocol (Optional[str]) – The protocol.
rds_db_cluster_arn (Optional[str]) – The ARN of the DB cluster.
rds_db_instance_arn (Optional[str]) – The ARN of the RDS instance.
rds_db_proxy_arn (Optional[str]) – The ARN of the RDS proxy.
rds_endpoint (Optional[str]) – The RDS endpoint.
subnet_ids (Optional[Sequence[str]]) – The IDs of the subnets. You can specify only one subnet per Availability Zone.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.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_ec2 import mixins as ec2_mixins

rds_options_property = ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.RdsOptionsProperty(
    port=123,
    protocol="protocol",
    rds_db_cluster_arn="rdsDbClusterArn",
    rds_db_instance_arn="rdsDbInstanceArn",
    rds_db_proxy_arn="rdsDbProxyArn",
    rds_endpoint="rdsEndpoint",
    subnet_ids=["subnetIds"]
)

Attributes

port

The port.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-port

protocol

The protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-protocol

rds_db_cluster_arn

The ARN of the DB cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-rdsdbclusterarn

rds_db_instance_arn

The ARN of the RDS instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-rdsdbinstancearn

rds_db_proxy_arn

The ARN of the RDS proxy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-rdsdbproxyarn

rds_endpoint

The RDS endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-rdsendpoint

subnet_ids

The IDs of the subnets.

You can specify only one subnet per Availability Zone.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-rdsoptions.html#cfn-ec2-verifiedaccessendpoint-rdsoptions-subnetids

SseSpecificationProperty

class CfnVerifiedAccessEndpointPropsMixin.SseSpecificationProperty(*, customer_managed_key_enabled=None, kms_key_arn=None)

Bases: object

AWS Verified Access provides server side encryption by default to data at rest using AWS -owned KMS keys.

You also have the option of using customer managed KMS keys, which can be specified using the options below.

Parameters:

customer_managed_key_enabled (Union[bool, IResolvable, None]) – Enable or disable the use of customer managed KMS keys for server side encryption. Valid values: True | False
kms_key_arn (Optional[str]) – The ARN of the KMS key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-ssespecification.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_ec2 import mixins as ec2_mixins

sse_specification_property = ec2_mixins.CfnVerifiedAccessEndpointPropsMixin.SseSpecificationProperty(
    customer_managed_key_enabled=False,
    kms_key_arn="kmsKeyArn"
)

Attributes

customer_managed_key_enabled

Enable or disable the use of customer managed KMS keys for server side encryption.

Valid values: True | False

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-ssespecification.html#cfn-ec2-verifiedaccessendpoint-ssespecification-customermanagedkeyenabled

kms_key_arn

The ARN of the KMS key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-verifiedaccessendpoint-ssespecification.html#cfn-ec2-verifiedaccessendpoint-ssespecification-kmskeyarn