ec2clientvpn

package
v2.0.0-beta.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 1, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

nolint: lll

nolint: lll

nolint: lll

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Endpoint 

type Endpoint struct {
	pulumi.CustomResourceState

	// Information about the authentication method to be used to authenticate clients.
	AuthenticationOptions EndpointAuthenticationOptionsOutput `pulumi:"authenticationOptions"`
	// 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.
	ClientCidrBlock pulumi.StringOutput `pulumi:"clientCidrBlock"`
	// Information about the client connection logging options.
	ConnectionLogOptions EndpointConnectionLogOptionsOutput `pulumi:"connectionLogOptions"`
	// Name of the repository.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The DNS name to be used by clients when establishing their VPN session.
	DnsName pulumi.StringOutput `pulumi:"dnsName"`
	// 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.
	DnsServers pulumi.StringArrayOutput `pulumi:"dnsServers"`
	// The ARN of the ACM server certificate.
	ServerCertificateArn pulumi.StringOutput `pulumi:"serverCertificateArn"`
	// Indicates whether split-tunnel is enabled on VPN endpoint. Default value is `false`.
	SplitTunnel pulumi.BoolPtrOutput `pulumi:"splitTunnel"`
	// The current state of the Client VPN endpoint.
	Status pulumi.StringOutput `pulumi:"status"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapOutput `pulumi:"tags"`
	// The transport protocol to be used by the VPN session. Default value is `udp`.
	TransportProtocol pulumi.StringPtrOutput `pulumi:"transportProtocol"`
}

Provides an AWS Client VPN endpoint for OpenVPN clients. For more information on usage, please see the [AWS Client VPN Administrator's Guide](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/what-is.html).

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/ec2_client_vpn_endpoint.html.markdown.

func GetEndpoint 

func GetEndpoint(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EndpointState, opts ...pulumi.ResourceOption) (*Endpoint, error)

GetEndpoint gets an existing Endpoint resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEndpoint 

func NewEndpoint(ctx *pulumi.Context,
	name string, args *EndpointArgs, opts ...pulumi.ResourceOption) (*Endpoint, error)

NewEndpoint registers a new resource with the given unique name, arguments, and options.

type EndpointArgs 

type EndpointArgs struct {
	// Information about the authentication method to be used to authenticate clients.
	AuthenticationOptions EndpointAuthenticationOptionsInput
	// 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.
	ClientCidrBlock pulumi.StringInput
	// Information about the client connection logging options.
	ConnectionLogOptions EndpointConnectionLogOptionsInput
	// Name of the repository.
	Description pulumi.StringPtrInput
	// 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.
	DnsServers pulumi.StringArrayInput
	// The ARN of the ACM server certificate.
	ServerCertificateArn pulumi.StringInput
	// Indicates whether split-tunnel is enabled on VPN endpoint. Default value is `false`.
	SplitTunnel pulumi.BoolPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapInput
	// The transport protocol to be used by the VPN session. Default value is `udp`.
	TransportProtocol pulumi.StringPtrInput
}

The set of arguments for constructing a Endpoint resource.

func (EndpointArgs) ElementType 

func (EndpointArgs) ElementType() reflect.Type

type EndpointAuthenticationOptions 

type EndpointAuthenticationOptions struct {
	// The ID of the Active Directory to be used for authentication if type is `directory-service-authentication`.
	ActiveDirectoryId *string `pulumi:"activeDirectoryId"`
	// The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM). Only necessary when type is set to `certificate-authentication`.
	RootCertificateChainArn *string `pulumi:"rootCertificateChainArn"`
	// The type of client authentication to be used. Specify `certificate-authentication` to use certificate-based authentication, or `directory-service-authentication` to use Active Directory authentication.
	Type string `pulumi:"type"`
}

type EndpointAuthenticationOptionsArgs 

type EndpointAuthenticationOptionsArgs struct {
	// The ID of the Active Directory to be used for authentication if type is `directory-service-authentication`.
	ActiveDirectoryId pulumi.StringPtrInput `pulumi:"activeDirectoryId"`
	// The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM). Only necessary when type is set to `certificate-authentication`.
	RootCertificateChainArn pulumi.StringPtrInput `pulumi:"rootCertificateChainArn"`
	// The type of client authentication to be used. Specify `certificate-authentication` to use certificate-based authentication, or `directory-service-authentication` to use Active Directory authentication.
	Type pulumi.StringInput `pulumi:"type"`
}

func (EndpointAuthenticationOptionsArgs) ElementType 

func (EndpointAuthenticationOptionsArgs) ElementType() reflect.Type

func (EndpointAuthenticationOptionsArgs) ToEndpointAuthenticationOptionsOutput 

func (i EndpointAuthenticationOptionsArgs) ToEndpointAuthenticationOptionsOutput() EndpointAuthenticationOptionsOutput

func (EndpointAuthenticationOptionsArgs) ToEndpointAuthenticationOptionsOutputWithContext 

func (i EndpointAuthenticationOptionsArgs) ToEndpointAuthenticationOptionsOutputWithContext(ctx context.Context) EndpointAuthenticationOptionsOutput

func (EndpointAuthenticationOptionsArgs) ToEndpointAuthenticationOptionsPtrOutput 

func (i EndpointAuthenticationOptionsArgs) ToEndpointAuthenticationOptionsPtrOutput() EndpointAuthenticationOptionsPtrOutput

func (EndpointAuthenticationOptionsArgs) ToEndpointAuthenticationOptionsPtrOutputWithContext 

func (i EndpointAuthenticationOptionsArgs) ToEndpointAuthenticationOptionsPtrOutputWithContext(ctx context.Context) EndpointAuthenticationOptionsPtrOutput

type EndpointAuthenticationOptionsInput 

type EndpointAuthenticationOptionsInput interface {
	pulumi.Input

	ToEndpointAuthenticationOptionsOutput() EndpointAuthenticationOptionsOutput
	ToEndpointAuthenticationOptionsOutputWithContext(context.Context) EndpointAuthenticationOptionsOutput
}

type EndpointAuthenticationOptionsOutput 

type EndpointAuthenticationOptionsOutput struct{ *pulumi.OutputState }

func (EndpointAuthenticationOptionsOutput) ActiveDirectoryId 

func (o EndpointAuthenticationOptionsOutput) ActiveDirectoryId() pulumi.StringPtrOutput

The ID of the Active Directory to be used for authentication if type is `directory-service-authentication`.

func (EndpointAuthenticationOptionsOutput) ElementType 

func (EndpointAuthenticationOptionsOutput) ElementType() reflect.Type

func (EndpointAuthenticationOptionsOutput) RootCertificateChainArn 

func (o EndpointAuthenticationOptionsOutput) RootCertificateChainArn() pulumi.StringPtrOutput

The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM). Only necessary when type is set to `certificate-authentication`.

func (EndpointAuthenticationOptionsOutput) ToEndpointAuthenticationOptionsOutput 

func (o EndpointAuthenticationOptionsOutput) ToEndpointAuthenticationOptionsOutput() EndpointAuthenticationOptionsOutput

func (EndpointAuthenticationOptionsOutput) ToEndpointAuthenticationOptionsOutputWithContext 

func (o EndpointAuthenticationOptionsOutput) ToEndpointAuthenticationOptionsOutputWithContext(ctx context.Context) EndpointAuthenticationOptionsOutput

func (EndpointAuthenticationOptionsOutput) ToEndpointAuthenticationOptionsPtrOutput 

func (o EndpointAuthenticationOptionsOutput) ToEndpointAuthenticationOptionsPtrOutput() EndpointAuthenticationOptionsPtrOutput

func (EndpointAuthenticationOptionsOutput) ToEndpointAuthenticationOptionsPtrOutputWithContext 

func (o EndpointAuthenticationOptionsOutput) ToEndpointAuthenticationOptionsPtrOutputWithContext(ctx context.Context) EndpointAuthenticationOptionsPtrOutput

func (EndpointAuthenticationOptionsOutput) Type 

func (o EndpointAuthenticationOptionsOutput) Type() pulumi.StringOutput

The type of client authentication to be used. Specify `certificate-authentication` to use certificate-based authentication, or `directory-service-authentication` to use Active Directory authentication.

type EndpointAuthenticationOptionsPtrInput 

type EndpointAuthenticationOptionsPtrInput interface {
	pulumi.Input

	ToEndpointAuthenticationOptionsPtrOutput() EndpointAuthenticationOptionsPtrOutput
	ToEndpointAuthenticationOptionsPtrOutputWithContext(context.Context) EndpointAuthenticationOptionsPtrOutput
}

func EndpointAuthenticationOptionsPtr 

func EndpointAuthenticationOptionsPtr(v *EndpointAuthenticationOptionsArgs) EndpointAuthenticationOptionsPtrInput

type EndpointAuthenticationOptionsPtrOutput 

type EndpointAuthenticationOptionsPtrOutput struct{ *pulumi.OutputState }

func (EndpointAuthenticationOptionsPtrOutput) ActiveDirectoryId 

func (o EndpointAuthenticationOptionsPtrOutput) ActiveDirectoryId() pulumi.StringPtrOutput

The ID of the Active Directory to be used for authentication if type is `directory-service-authentication`.

func (EndpointAuthenticationOptionsPtrOutput) Elem 

func (o EndpointAuthenticationOptionsPtrOutput) Elem() EndpointAuthenticationOptionsOutput

func (EndpointAuthenticationOptionsPtrOutput) ElementType 

func (EndpointAuthenticationOptionsPtrOutput) ElementType() reflect.Type

func (EndpointAuthenticationOptionsPtrOutput) RootCertificateChainArn 

func (o EndpointAuthenticationOptionsPtrOutput) RootCertificateChainArn() pulumi.StringPtrOutput

The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM). Only necessary when type is set to `certificate-authentication`.

func (EndpointAuthenticationOptionsPtrOutput) ToEndpointAuthenticationOptionsPtrOutput 

func (o EndpointAuthenticationOptionsPtrOutput) ToEndpointAuthenticationOptionsPtrOutput() EndpointAuthenticationOptionsPtrOutput

func (EndpointAuthenticationOptionsPtrOutput) ToEndpointAuthenticationOptionsPtrOutputWithContext 

func (o EndpointAuthenticationOptionsPtrOutput) ToEndpointAuthenticationOptionsPtrOutputWithContext(ctx context.Context) EndpointAuthenticationOptionsPtrOutput

func (EndpointAuthenticationOptionsPtrOutput) Type 

func (o EndpointAuthenticationOptionsPtrOutput) Type() pulumi.StringOutput

The type of client authentication to be used. Specify `certificate-authentication` to use certificate-based authentication, or `directory-service-authentication` to use Active Directory authentication.

type EndpointConnectionLogOptions 

type EndpointConnectionLogOptions struct {
	// The name of the CloudWatch Logs log group.
	CloudwatchLogGroup *string `pulumi:"cloudwatchLogGroup"`
	// The name of the CloudWatch Logs log stream to which the connection data is published.
	CloudwatchLogStream *string `pulumi:"cloudwatchLogStream"`
	// Indicates whether connection logging is enabled.
	Enabled bool `pulumi:"enabled"`
}

type EndpointConnectionLogOptionsArgs 

type EndpointConnectionLogOptionsArgs struct {
	// The name of the CloudWatch Logs log group.
	CloudwatchLogGroup pulumi.StringPtrInput `pulumi:"cloudwatchLogGroup"`
	// The name of the CloudWatch Logs log stream to which the connection data is published.
	CloudwatchLogStream pulumi.StringPtrInput `pulumi:"cloudwatchLogStream"`
	// Indicates whether connection logging is enabled.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
}

func (EndpointConnectionLogOptionsArgs) ElementType 

func (EndpointConnectionLogOptionsArgs) ElementType() reflect.Type

func (EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsOutput 

func (i EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsOutput() EndpointConnectionLogOptionsOutput

func (EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsOutputWithContext 

func (i EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsOutput

func (EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsPtrOutput 

func (i EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsPtrOutput() EndpointConnectionLogOptionsPtrOutput

func (EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsPtrOutputWithContext 

func (i EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsPtrOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsPtrOutput

type EndpointConnectionLogOptionsInput 

type EndpointConnectionLogOptionsInput interface {
	pulumi.Input

	ToEndpointConnectionLogOptionsOutput() EndpointConnectionLogOptionsOutput
	ToEndpointConnectionLogOptionsOutputWithContext(context.Context) EndpointConnectionLogOptionsOutput
}

type EndpointConnectionLogOptionsOutput 

type EndpointConnectionLogOptionsOutput struct{ *pulumi.OutputState }

func (EndpointConnectionLogOptionsOutput) CloudwatchLogGroup 

func (o EndpointConnectionLogOptionsOutput) CloudwatchLogGroup() pulumi.StringPtrOutput

The name of the CloudWatch Logs log group.

func (EndpointConnectionLogOptionsOutput) CloudwatchLogStream 

func (o EndpointConnectionLogOptionsOutput) CloudwatchLogStream() pulumi.StringPtrOutput

The name of the CloudWatch Logs log stream to which the connection data is published.

func (EndpointConnectionLogOptionsOutput) ElementType 

func (EndpointConnectionLogOptionsOutput) ElementType() reflect.Type

func (EndpointConnectionLogOptionsOutput) Enabled 

func (o EndpointConnectionLogOptionsOutput) Enabled() pulumi.BoolOutput

Indicates whether connection logging is enabled.

func (EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsOutput 

func (o EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsOutput() EndpointConnectionLogOptionsOutput

func (EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsOutputWithContext 

func (o EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsOutput

func (EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsPtrOutput 

func (o EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsPtrOutput() EndpointConnectionLogOptionsPtrOutput

func (EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsPtrOutputWithContext 

func (o EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsPtrOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsPtrOutput

type EndpointConnectionLogOptionsPtrInput 

type EndpointConnectionLogOptionsPtrInput interface {
	pulumi.Input

	ToEndpointConnectionLogOptionsPtrOutput() EndpointConnectionLogOptionsPtrOutput
	ToEndpointConnectionLogOptionsPtrOutputWithContext(context.Context) EndpointConnectionLogOptionsPtrOutput
}

func EndpointConnectionLogOptionsPtr 

func EndpointConnectionLogOptionsPtr(v *EndpointConnectionLogOptionsArgs) EndpointConnectionLogOptionsPtrInput

type EndpointConnectionLogOptionsPtrOutput 

type EndpointConnectionLogOptionsPtrOutput struct{ *pulumi.OutputState }

func (EndpointConnectionLogOptionsPtrOutput) CloudwatchLogGroup 

func (o EndpointConnectionLogOptionsPtrOutput) CloudwatchLogGroup() pulumi.StringPtrOutput

The name of the CloudWatch Logs log group.

func (EndpointConnectionLogOptionsPtrOutput) CloudwatchLogStream 

func (o EndpointConnectionLogOptionsPtrOutput) CloudwatchLogStream() pulumi.StringPtrOutput

The name of the CloudWatch Logs log stream to which the connection data is published.

func (EndpointConnectionLogOptionsPtrOutput) Elem 

func (o EndpointConnectionLogOptionsPtrOutput) Elem() EndpointConnectionLogOptionsOutput

func (EndpointConnectionLogOptionsPtrOutput) ElementType 

func (EndpointConnectionLogOptionsPtrOutput) ElementType() reflect.Type

func (EndpointConnectionLogOptionsPtrOutput) Enabled 

func (o EndpointConnectionLogOptionsPtrOutput) Enabled() pulumi.BoolOutput

Indicates whether connection logging is enabled.

func (EndpointConnectionLogOptionsPtrOutput) ToEndpointConnectionLogOptionsPtrOutput 

func (o EndpointConnectionLogOptionsPtrOutput) ToEndpointConnectionLogOptionsPtrOutput() EndpointConnectionLogOptionsPtrOutput

func (EndpointConnectionLogOptionsPtrOutput) ToEndpointConnectionLogOptionsPtrOutputWithContext 

func (o EndpointConnectionLogOptionsPtrOutput) ToEndpointConnectionLogOptionsPtrOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsPtrOutput

type EndpointState 

type EndpointState struct {
	// Information about the authentication method to be used to authenticate clients.
	AuthenticationOptions EndpointAuthenticationOptionsPtrInput
	// 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.
	ClientCidrBlock pulumi.StringPtrInput
	// Information about the client connection logging options.
	ConnectionLogOptions EndpointConnectionLogOptionsPtrInput
	// Name of the repository.
	Description pulumi.StringPtrInput
	// The DNS name to be used by clients when establishing their VPN session.
	DnsName pulumi.StringPtrInput
	// 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.
	DnsServers pulumi.StringArrayInput
	// The ARN of the ACM server certificate.
	ServerCertificateArn pulumi.StringPtrInput
	// Indicates whether split-tunnel is enabled on VPN endpoint. Default value is `false`.
	SplitTunnel pulumi.BoolPtrInput
	// The current state of the Client VPN endpoint.
	Status pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapInput
	// The transport protocol to be used by the VPN session. Default value is `udp`.
	TransportProtocol pulumi.StringPtrInput
}

func (EndpointState) ElementType 

func (EndpointState) ElementType() reflect.Type

type NetworkAssociation 

type NetworkAssociation struct {
	pulumi.CustomResourceState

	// The ID of the Client VPN endpoint.
	ClientVpnEndpointId pulumi.StringOutput `pulumi:"clientVpnEndpointId"`
	// The IDs of the security groups applied to the target network association.
	SecurityGroups pulumi.StringArrayOutput `pulumi:"securityGroups"`
	// The current state of the target network association.
	Status pulumi.StringOutput `pulumi:"status"`
	// The ID of the subnet to associate with the Client VPN endpoint.
	SubnetId pulumi.StringOutput `pulumi:"subnetId"`
	// The ID of the VPC in which the target network (subnet) is located.
	VpcId pulumi.StringOutput `pulumi:"vpcId"`
}

Provides network associations for AWS Client VPN endpoints. For more information on usage, please see the [AWS Client VPN Administrator's Guide](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/what-is.html).

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/ec2_client_vpn_network_association.html.markdown.

func GetNetworkAssociation 

func GetNetworkAssociation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *NetworkAssociationState, opts ...pulumi.ResourceOption) (*NetworkAssociation, error)

GetNetworkAssociation gets an existing NetworkAssociation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewNetworkAssociation 

func NewNetworkAssociation(ctx *pulumi.Context,
	name string, args *NetworkAssociationArgs, opts ...pulumi.ResourceOption) (*NetworkAssociation, error)

NewNetworkAssociation registers a new resource with the given unique name, arguments, and options.

type NetworkAssociationArgs 

type NetworkAssociationArgs struct {
	// The ID of the Client VPN endpoint.
	ClientVpnEndpointId pulumi.StringInput
	// The ID of the subnet to associate with the Client VPN endpoint.
	SubnetId pulumi.StringInput
}

The set of arguments for constructing a NetworkAssociation resource.

func (NetworkAssociationArgs) ElementType 

func (NetworkAssociationArgs) ElementType() reflect.Type

type NetworkAssociationState 

type NetworkAssociationState struct {
	// The ID of the Client VPN endpoint.
	ClientVpnEndpointId pulumi.StringPtrInput
	// The IDs of the security groups applied to the target network association.
	SecurityGroups pulumi.StringArrayInput
	// The current state of the target network association.
	Status pulumi.StringPtrInput
	// The ID of the subnet to associate with the Client VPN endpoint.
	SubnetId pulumi.StringPtrInput
	// The ID of the VPC in which the target network (subnet) is located.
	VpcId pulumi.StringPtrInput
}

func (NetworkAssociationState) ElementType 

func (NetworkAssociationState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.