CfnClientVpnEndpoint

class aws_cdk.aws_ec2.CfnClientVpnEndpoint(scope, id, *, authentication_options, client_cidr_block, connection_log_options, server_certificate_arn, description=None, dns_servers=None, security_group_ids=None, split_tunnel=None, tag_specifications=None, transport_protocol=None, vpc_id=None, vpn_port=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::EC2::ClientVpnEndpoint.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html

CloudformationResource

AWS::EC2::ClientVpnEndpoint

Create a new AWS::EC2::ClientVpnEndpoint.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • authentication_options (Union[IResolvable, List[Union[ClientAuthenticationRequestProperty, IResolvable]]]) – AWS::EC2::ClientVpnEndpoint.AuthenticationOptions.

  • client_cidr_block (str) – AWS::EC2::ClientVpnEndpoint.ClientCidrBlock.

  • connection_log_options (Union[IResolvable, ConnectionLogOptionsProperty]) – AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions.

  • server_certificate_arn (str) – AWS::EC2::ClientVpnEndpoint.ServerCertificateArn.

  • description (Optional[str]) – AWS::EC2::ClientVpnEndpoint.Description.

  • dns_servers (Optional[List[str]]) – AWS::EC2::ClientVpnEndpoint.DnsServers.

  • security_group_ids (Optional[List[str]]) – AWS::EC2::ClientVpnEndpoint.SecurityGroupIds.

  • split_tunnel (Union[bool, IResolvable, None]) – AWS::EC2::ClientVpnEndpoint.SplitTunnel.

  • tag_specifications (Union[IResolvable, List[Union[IResolvable, TagSpecificationProperty]], None]) – AWS::EC2::ClientVpnEndpoint.TagSpecifications.

  • transport_protocol (Optional[str]) – AWS::EC2::ClientVpnEndpoint.TransportProtocol.

  • vpc_id (Optional[str]) – AWS::EC2::ClientVpnEndpoint.VpcId.

  • vpn_port (Union[int, float, None]) – AWS::EC2::ClientVpnEndpoint.VpnPort.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\." because the \ itself will need to be escaped.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::EC2::ClientVpnEndpoint'
authentication_options

AWS::EC2::ClientVpnEndpoint.AuthenticationOptions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions

Return type

Union[IResolvable, List[Union[ClientAuthenticationRequestProperty, IResolvable]]]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

client_cidr_block

AWS::EC2::ClientVpnEndpoint.ClientCidrBlock.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientcidrblock

Return type

str

connection_log_options

AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions

Return type

Union[IResolvable, ConnectionLogOptionsProperty]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

description

AWS::EC2::ClientVpnEndpoint.Description.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-description

Return type

Optional[str]

dns_servers

AWS::EC2::ClientVpnEndpoint.DnsServers.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-dnsservers

Return type

Optional[List[str]]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

security_group_ids

AWS::EC2::ClientVpnEndpoint.SecurityGroupIds.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-securitygroupids

Return type

Optional[List[str]]

server_certificate_arn

AWS::EC2::ClientVpnEndpoint.ServerCertificateArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-servercertificatearn

Return type

str

split_tunnel

AWS::EC2::ClientVpnEndpoint.SplitTunnel.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel

Return type

Union[bool, IResolvable, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tag_specifications

AWS::EC2::ClientVpnEndpoint.TagSpecifications.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications

Return type

Union[IResolvable, List[Union[IResolvable, TagSpecificationProperty]], None]

transport_protocol

AWS::EC2::ClientVpnEndpoint.TransportProtocol.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-transportprotocol

Return type

Optional[str]

vpc_id

AWS::EC2::ClientVpnEndpoint.VpcId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpcid

Return type

Optional[str]

vpn_port

AWS::EC2::ClientVpnEndpoint.VpnPort.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport

Return type

Union[int, float, None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

CertificateAuthenticationRequestProperty

class CfnClientVpnEndpoint.CertificateAuthenticationRequestProperty(*, client_root_certificate_chain_arn)

Bases: object

Parameters

client_root_certificate_chain_arn (str) – CfnClientVpnEndpoint.CertificateAuthenticationRequestProperty.ClientRootCertificateChainArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html

Attributes

client_root_certificate_chain_arn

CfnClientVpnEndpoint.CertificateAuthenticationRequestProperty.ClientRootCertificateChainArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.html#cfn-ec2-clientvpnendpoint-certificateauthenticationrequest-clientrootcertificatechainarn

Return type

str

ClientAuthenticationRequestProperty

class CfnClientVpnEndpoint.ClientAuthenticationRequestProperty(*, type, active_directory=None, federated_authentication=None, mutual_authentication=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html

Attributes

active_directory

CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.ActiveDirectory.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-activedirectory

Return type

Union[IResolvable, DirectoryServiceAuthenticationRequestProperty, None]

federated_authentication

CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.FederatedAuthentication.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-federatedauthentication

Return type

Union[IResolvable, FederatedAuthenticationRequestProperty, None]

mutual_authentication

CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.MutualAuthentication.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-mutualauthentication

Return type

Union[IResolvable, CertificateAuthenticationRequestProperty, None]

type

CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.Type.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-type

Return type

str

ConnectionLogOptionsProperty

class CfnClientVpnEndpoint.ConnectionLogOptionsProperty(*, enabled, cloudwatch_log_group=None, cloudwatch_log_stream=None)

Bases: object

Parameters
  • enabled (Union[bool, IResolvable]) – CfnClientVpnEndpoint.ConnectionLogOptionsProperty.Enabled.

  • cloudwatch_log_group (Optional[str]) – CfnClientVpnEndpoint.ConnectionLogOptionsProperty.CloudwatchLogGroup.

  • cloudwatch_log_stream (Optional[str]) – CfnClientVpnEndpoint.ConnectionLogOptionsProperty.CloudwatchLogStream.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html

Attributes

cloudwatch_log_group

CfnClientVpnEndpoint.ConnectionLogOptionsProperty.CloudwatchLogGroup.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchloggroup

Return type

Optional[str]

cloudwatch_log_stream

CfnClientVpnEndpoint.ConnectionLogOptionsProperty.CloudwatchLogStream.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-cloudwatchlogstream

Return type

Optional[str]

enabled

CfnClientVpnEndpoint.ConnectionLogOptionsProperty.Enabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-connectionlogoptions.html#cfn-ec2-clientvpnendpoint-connectionlogoptions-enabled

Return type

Union[bool, IResolvable]

DirectoryServiceAuthenticationRequestProperty

class CfnClientVpnEndpoint.DirectoryServiceAuthenticationRequestProperty(*, directory_id)

Bases: object

Parameters

directory_id (str) – CfnClientVpnEndpoint.DirectoryServiceAuthenticationRequestProperty.DirectoryId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html

Attributes

directory_id

CfnClientVpnEndpoint.DirectoryServiceAuthenticationRequestProperty.DirectoryId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.html#cfn-ec2-clientvpnendpoint-directoryserviceauthenticationrequest-directoryid

Return type

str

FederatedAuthenticationRequestProperty

class CfnClientVpnEndpoint.FederatedAuthenticationRequestProperty(*, saml_provider_arn)

Bases: object

Parameters

saml_provider_arn (str) – CfnClientVpnEndpoint.FederatedAuthenticationRequestProperty.SAMLProviderArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html

Attributes

saml_provider_arn

CfnClientVpnEndpoint.FederatedAuthenticationRequestProperty.SAMLProviderArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html#cfn-ec2-clientvpnendpoint-federatedauthenticationrequest-samlproviderarn

Return type

str

TagSpecificationProperty

class CfnClientVpnEndpoint.TagSpecificationProperty(*, resource_type, tags)

Bases: object

Parameters
  • resource_type (str) – CfnClientVpnEndpoint.TagSpecificationProperty.ResourceType.

  • tags (List[CfnTag]) – CfnClientVpnEndpoint.TagSpecificationProperty.Tags.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html

Attributes

resource_type

CfnClientVpnEndpoint.TagSpecificationProperty.ResourceType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-resourcetype

Return type

str

tags

CfnClientVpnEndpoint.TagSpecificationProperty.Tags.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-tagspecification.html#cfn-ec2-clientvpnendpoint-tagspecification-tags

Return type

List[CfnTag]