Module ec2clientvpn

ec2clientvpn

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
class pulumi_aws.ec2clientvpn.Endpoint(resource_name, opts=None, authentication_options=None, client_cidr_block=None, connection_log_options=None, description=None, dns_servers=None, server_certificate_arn=None, split_tunnel=None, tags=None, transport_protocol=None, __props__=None, __name__=None, __opts__=None)

Provides an AWS Client VPN endpoint for OpenVPN clients. For more information on usage, please see the AWS Client VPN Administrator’s Guide.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • authentication_options (pulumi.Input[dict]) – Information about the authentication method to be used to authenticate clients.
  • client_cidr_block (pulumi.Input[str]) – The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.
  • connection_log_options (pulumi.Input[dict]) – Information about the client connection logging options.
  • description (pulumi.Input[str]) – Name of the repository.
  • dns_servers (pulumi.Input[list]) – Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.
  • server_certificate_arn (pulumi.Input[str]) – The ARN of the ACM server certificate.
  • split_tunnel (pulumi.Input[bool]) – Indicates whether split-tunnel is enabled on VPN endpoint. Default value is false.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • transport_protocol (pulumi.Input[str]) – The transport protocol to be used by the VPN session. Default value is udp.
authentication_options = None

Information about the authentication method to be used to authenticate clients.

client_cidr_block = None

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

connection_log_options = None

Information about the client connection logging options.

description = None

Name of the repository.

dns_name = None

The DNS name to be used by clients when establishing their VPN session.

dns_servers = None

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.

server_certificate_arn = None

The ARN of the ACM server certificate.

split_tunnel = None

Indicates whether split-tunnel is enabled on VPN endpoint. Default value is false.

status = None

The current state of the Client VPN endpoint.

tags = None

A mapping of tags to assign to the resource.

transport_protocol = None

The transport protocol to be used by the VPN session. Default value is udp.

static get(resource_name, id, opts=None, authentication_options=None, client_cidr_block=None, connection_log_options=None, description=None, dns_name=None, dns_servers=None, server_certificate_arn=None, split_tunnel=None, status=None, tags=None, transport_protocol=None)

Get an existing Endpoint resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[dict] authentication_options: Information about the authentication method to be used to authenticate clients. :param pulumi.Input[str] client_cidr_block: The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. :param pulumi.Input[dict] connection_log_options: Information about the client connection logging options. :param pulumi.Input[str] description: Name of the repository. :param pulumi.Input[str] dns_name: The DNS name to be used by clients when establishing their VPN session. :param pulumi.Input[list] dns_servers: Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server. :param pulumi.Input[str] server_certificate_arn: The ARN of the ACM server certificate. :param pulumi.Input[bool] split_tunnel: Indicates whether split-tunnel is enabled on VPN endpoint. Default value is false. :param pulumi.Input[str] status: The current state of the Client VPN endpoint. :param pulumi.Input[dict] tags: A mapping of tags to assign to the resource. :param pulumi.Input[str] transport_protocol: The transport protocol to be used by the VPN session. Default value is udp.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ec2clientvpn.NetworkAssociation(resource_name, opts=None, client_vpn_endpoint_id=None, subnet_id=None, __props__=None, __name__=None, __opts__=None)

Provides network associations for AWS Client VPN endpoints. For more information on usage, please see the AWS Client VPN Administrator’s Guide.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • client_vpn_endpoint_id (pulumi.Input[str]) – The ID of the Client VPN endpoint.
  • subnet_id (pulumi.Input[str]) – The ID of the subnet to associate with the Client VPN endpoint.
client_vpn_endpoint_id = None

The ID of the Client VPN endpoint.

security_groups = None

The IDs of the security groups applied to the target network association.

status = None

The current state of the target network association.

subnet_id = None

The ID of the subnet to associate with the Client VPN endpoint.

vpc_id = None

The ID of the VPC in which the target network (subnet) is located.

static get(resource_name, id, opts=None, client_vpn_endpoint_id=None, security_groups=None, status=None, subnet_id=None, vpc_id=None)

Get an existing NetworkAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] client_vpn_endpoint_id: The ID of the Client VPN endpoint. :param pulumi.Input[list] security_groups: The IDs of the security groups applied to the target network association. :param pulumi.Input[str] status: The current state of the target network association. :param pulumi.Input[str] subnet_id: The ID of the subnet to associate with the Client VPN endpoint. :param pulumi.Input[str] vpc_id: The ID of the VPC in which the target network (subnet) is located.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str