Documentation ¶
Index ¶
- type AuthorizationRule
- func (*AuthorizationRule) ElementType() reflect.Type
- func (i *AuthorizationRule) ToAuthorizationRuleOutput() AuthorizationRuleOutput
- func (i *AuthorizationRule) ToAuthorizationRuleOutputWithContext(ctx context.Context) AuthorizationRuleOutput
- func (i *AuthorizationRule) ToAuthorizationRulePtrOutput() AuthorizationRulePtrOutput
- func (i *AuthorizationRule) ToAuthorizationRulePtrOutputWithContext(ctx context.Context) AuthorizationRulePtrOutput
- type AuthorizationRuleArgs
- type AuthorizationRuleArray
- type AuthorizationRuleArrayInput
- type AuthorizationRuleArrayOutput
- func (AuthorizationRuleArrayOutput) ElementType() reflect.Type
- func (o AuthorizationRuleArrayOutput) Index(i pulumi.IntInput) AuthorizationRuleOutput
- func (o AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutput() AuthorizationRuleArrayOutput
- func (o AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutputWithContext(ctx context.Context) AuthorizationRuleArrayOutput
- type AuthorizationRuleInput
- type AuthorizationRuleMap
- type AuthorizationRuleMapInput
- type AuthorizationRuleMapOutput
- func (AuthorizationRuleMapOutput) ElementType() reflect.Type
- func (o AuthorizationRuleMapOutput) MapIndex(k pulumi.StringInput) AuthorizationRuleOutput
- func (o AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutput() AuthorizationRuleMapOutput
- func (o AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutputWithContext(ctx context.Context) AuthorizationRuleMapOutput
- type AuthorizationRuleOutput
- func (AuthorizationRuleOutput) ElementType() reflect.Type
- func (o AuthorizationRuleOutput) ToAuthorizationRuleOutput() AuthorizationRuleOutput
- func (o AuthorizationRuleOutput) ToAuthorizationRuleOutputWithContext(ctx context.Context) AuthorizationRuleOutput
- func (o AuthorizationRuleOutput) ToAuthorizationRulePtrOutput() AuthorizationRulePtrOutput
- func (o AuthorizationRuleOutput) ToAuthorizationRulePtrOutputWithContext(ctx context.Context) AuthorizationRulePtrOutput
- type AuthorizationRulePtrInput
- type AuthorizationRulePtrOutput
- type AuthorizationRuleState
- type Endpoint
- func (*Endpoint) ElementType() reflect.Type
- func (i *Endpoint) ToEndpointOutput() EndpointOutput
- func (i *Endpoint) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput
- func (i *Endpoint) ToEndpointPtrOutput() EndpointPtrOutput
- func (i *Endpoint) ToEndpointPtrOutputWithContext(ctx context.Context) EndpointPtrOutput
- type EndpointArgs
- type EndpointArray
- type EndpointArrayInput
- type EndpointArrayOutput
- type EndpointAuthenticationOption
- type EndpointAuthenticationOptionArgs
- func (EndpointAuthenticationOptionArgs) ElementType() reflect.Type
- func (i EndpointAuthenticationOptionArgs) ToEndpointAuthenticationOptionOutput() EndpointAuthenticationOptionOutput
- func (i EndpointAuthenticationOptionArgs) ToEndpointAuthenticationOptionOutputWithContext(ctx context.Context) EndpointAuthenticationOptionOutput
- type EndpointAuthenticationOptionArray
- func (EndpointAuthenticationOptionArray) ElementType() reflect.Type
- func (i EndpointAuthenticationOptionArray) ToEndpointAuthenticationOptionArrayOutput() EndpointAuthenticationOptionArrayOutput
- func (i EndpointAuthenticationOptionArray) ToEndpointAuthenticationOptionArrayOutputWithContext(ctx context.Context) EndpointAuthenticationOptionArrayOutput
- type EndpointAuthenticationOptionArrayInput
- type EndpointAuthenticationOptionArrayOutput
- func (EndpointAuthenticationOptionArrayOutput) ElementType() reflect.Type
- func (o EndpointAuthenticationOptionArrayOutput) Index(i pulumi.IntInput) EndpointAuthenticationOptionOutput
- func (o EndpointAuthenticationOptionArrayOutput) ToEndpointAuthenticationOptionArrayOutput() EndpointAuthenticationOptionArrayOutput
- func (o EndpointAuthenticationOptionArrayOutput) ToEndpointAuthenticationOptionArrayOutputWithContext(ctx context.Context) EndpointAuthenticationOptionArrayOutput
- type EndpointAuthenticationOptionInput
- type EndpointAuthenticationOptionOutput
- func (o EndpointAuthenticationOptionOutput) ActiveDirectoryId() pulumi.StringPtrOutput
- func (EndpointAuthenticationOptionOutput) ElementType() reflect.Type
- func (o EndpointAuthenticationOptionOutput) RootCertificateChainArn() pulumi.StringPtrOutput
- func (o EndpointAuthenticationOptionOutput) SamlProviderArn() pulumi.StringPtrOutput
- func (o EndpointAuthenticationOptionOutput) ToEndpointAuthenticationOptionOutput() EndpointAuthenticationOptionOutput
- func (o EndpointAuthenticationOptionOutput) ToEndpointAuthenticationOptionOutputWithContext(ctx context.Context) EndpointAuthenticationOptionOutput
- func (o EndpointAuthenticationOptionOutput) Type() pulumi.StringOutput
- type EndpointConnectionLogOptions
- type EndpointConnectionLogOptionsArgs
- func (EndpointConnectionLogOptionsArgs) ElementType() reflect.Type
- func (i EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsOutput() EndpointConnectionLogOptionsOutput
- func (i EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsOutput
- func (i EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsPtrOutput() EndpointConnectionLogOptionsPtrOutput
- func (i EndpointConnectionLogOptionsArgs) ToEndpointConnectionLogOptionsPtrOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsPtrOutput
- type EndpointConnectionLogOptionsInput
- type EndpointConnectionLogOptionsOutput
- func (o EndpointConnectionLogOptionsOutput) CloudwatchLogGroup() pulumi.StringPtrOutput
- func (o EndpointConnectionLogOptionsOutput) CloudwatchLogStream() pulumi.StringPtrOutput
- func (EndpointConnectionLogOptionsOutput) ElementType() reflect.Type
- func (o EndpointConnectionLogOptionsOutput) Enabled() pulumi.BoolOutput
- func (o EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsOutput() EndpointConnectionLogOptionsOutput
- func (o EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsOutput
- func (o EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsPtrOutput() EndpointConnectionLogOptionsPtrOutput
- func (o EndpointConnectionLogOptionsOutput) ToEndpointConnectionLogOptionsPtrOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsPtrOutput
- type EndpointConnectionLogOptionsPtrInput
- type EndpointConnectionLogOptionsPtrOutput
- func (o EndpointConnectionLogOptionsPtrOutput) CloudwatchLogGroup() pulumi.StringPtrOutput
- func (o EndpointConnectionLogOptionsPtrOutput) CloudwatchLogStream() pulumi.StringPtrOutput
- func (o EndpointConnectionLogOptionsPtrOutput) Elem() EndpointConnectionLogOptionsOutput
- func (EndpointConnectionLogOptionsPtrOutput) ElementType() reflect.Type
- func (o EndpointConnectionLogOptionsPtrOutput) Enabled() pulumi.BoolPtrOutput
- func (o EndpointConnectionLogOptionsPtrOutput) ToEndpointConnectionLogOptionsPtrOutput() EndpointConnectionLogOptionsPtrOutput
- func (o EndpointConnectionLogOptionsPtrOutput) ToEndpointConnectionLogOptionsPtrOutputWithContext(ctx context.Context) EndpointConnectionLogOptionsPtrOutput
- type EndpointInput
- type EndpointMap
- type EndpointMapInput
- type EndpointMapOutput
- type EndpointOutput
- func (EndpointOutput) ElementType() reflect.Type
- func (o EndpointOutput) ToEndpointOutput() EndpointOutput
- func (o EndpointOutput) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput
- func (o EndpointOutput) ToEndpointPtrOutput() EndpointPtrOutput
- func (o EndpointOutput) ToEndpointPtrOutputWithContext(ctx context.Context) EndpointPtrOutput
- type EndpointPtrInput
- type EndpointPtrOutput
- type EndpointState
- type NetworkAssociation
- func (*NetworkAssociation) ElementType() reflect.Type
- func (i *NetworkAssociation) ToNetworkAssociationOutput() NetworkAssociationOutput
- func (i *NetworkAssociation) ToNetworkAssociationOutputWithContext(ctx context.Context) NetworkAssociationOutput
- func (i *NetworkAssociation) ToNetworkAssociationPtrOutput() NetworkAssociationPtrOutput
- func (i *NetworkAssociation) ToNetworkAssociationPtrOutputWithContext(ctx context.Context) NetworkAssociationPtrOutput
- type NetworkAssociationArgs
- type NetworkAssociationArray
- type NetworkAssociationArrayInput
- type NetworkAssociationArrayOutput
- func (NetworkAssociationArrayOutput) ElementType() reflect.Type
- func (o NetworkAssociationArrayOutput) Index(i pulumi.IntInput) NetworkAssociationOutput
- func (o NetworkAssociationArrayOutput) ToNetworkAssociationArrayOutput() NetworkAssociationArrayOutput
- func (o NetworkAssociationArrayOutput) ToNetworkAssociationArrayOutputWithContext(ctx context.Context) NetworkAssociationArrayOutput
- type NetworkAssociationInput
- type NetworkAssociationMap
- type NetworkAssociationMapInput
- type NetworkAssociationMapOutput
- func (NetworkAssociationMapOutput) ElementType() reflect.Type
- func (o NetworkAssociationMapOutput) MapIndex(k pulumi.StringInput) NetworkAssociationOutput
- func (o NetworkAssociationMapOutput) ToNetworkAssociationMapOutput() NetworkAssociationMapOutput
- func (o NetworkAssociationMapOutput) ToNetworkAssociationMapOutputWithContext(ctx context.Context) NetworkAssociationMapOutput
- type NetworkAssociationOutput
- func (NetworkAssociationOutput) ElementType() reflect.Type
- func (o NetworkAssociationOutput) ToNetworkAssociationOutput() NetworkAssociationOutput
- func (o NetworkAssociationOutput) ToNetworkAssociationOutputWithContext(ctx context.Context) NetworkAssociationOutput
- func (o NetworkAssociationOutput) ToNetworkAssociationPtrOutput() NetworkAssociationPtrOutput
- func (o NetworkAssociationOutput) ToNetworkAssociationPtrOutputWithContext(ctx context.Context) NetworkAssociationPtrOutput
- type NetworkAssociationPtrInput
- type NetworkAssociationPtrOutput
- type NetworkAssociationState
- type Route
- type RouteArgs
- type RouteArray
- type RouteArrayInput
- type RouteArrayOutput
- type RouteInput
- type RouteMap
- type RouteMapInput
- type RouteMapOutput
- type RouteOutput
- func (RouteOutput) ElementType() reflect.Type
- func (o RouteOutput) ToRouteOutput() RouteOutput
- func (o RouteOutput) ToRouteOutputWithContext(ctx context.Context) RouteOutput
- func (o RouteOutput) ToRoutePtrOutput() RoutePtrOutput
- func (o RouteOutput) ToRoutePtrOutputWithContext(ctx context.Context) RoutePtrOutput
- type RoutePtrInput
- type RoutePtrOutput
- type RouteState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthorizationRule ¶
type AuthorizationRule struct { pulumi.CustomResourceState // The ID of the group to which the authorization rule grants access. One of `accessGroupId` or `authorizeAllGroups` must be set. AccessGroupId pulumi.StringPtrOutput `pulumi:"accessGroupId"` // Indicates whether the authorization rule grants access to all clients. One of `accessGroupId` or `authorizeAllGroups` must be set. AuthorizeAllGroups pulumi.BoolPtrOutput `pulumi:"authorizeAllGroups"` // The ID of the Client VPN endpoint. ClientVpnEndpointId pulumi.StringOutput `pulumi:"clientVpnEndpointId"` // A brief description of the authorization rule. Description pulumi.StringPtrOutput `pulumi:"description"` // The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. TargetNetworkCidr pulumi.StringOutput `pulumi:"targetNetworkCidr"` }
Provides authorization rules 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).
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2clientvpn" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := ec2clientvpn.NewAuthorizationRule(ctx, "example", &ec2clientvpn.AuthorizationRuleArgs{ ClientVpnEndpointId: pulumi.Any(aws_ec2_client_vpn_endpoint.Example.Id), TargetNetworkCidr: pulumi.Any(aws_subnet.Example.Cidr_block), AuthorizeAllGroups: pulumi.Bool(true), }) if err != nil { return err } return nil }) }
```
## Import
AWS Client VPN authorization rules can be imported using the endpoint ID and target network CIDR. If there is a specific group name that is included as well. All values are separated by a `,`.
```sh
$ pulumi import aws:ec2clientvpn/authorizationRule:AuthorizationRule example cvpn-endpoint-0ac3a1abbccddd666,10.1.0.0/24
```
```sh
$ pulumi import aws:ec2clientvpn/authorizationRule:AuthorizationRule example cvpn-endpoint-0ac3a1abbccddd666,10.1.0.0/24,team-a
```
func GetAuthorizationRule ¶
func GetAuthorizationRule(ctx *pulumi.Context, name string, id pulumi.IDInput, state *AuthorizationRuleState, opts ...pulumi.ResourceOption) (*AuthorizationRule, error)
GetAuthorizationRule gets an existing AuthorizationRule 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 NewAuthorizationRule ¶
func NewAuthorizationRule(ctx *pulumi.Context, name string, args *AuthorizationRuleArgs, opts ...pulumi.ResourceOption) (*AuthorizationRule, error)
NewAuthorizationRule registers a new resource with the given unique name, arguments, and options.
func (*AuthorizationRule) ElementType ¶
func (*AuthorizationRule) ElementType() reflect.Type
func (*AuthorizationRule) ToAuthorizationRuleOutput ¶
func (i *AuthorizationRule) ToAuthorizationRuleOutput() AuthorizationRuleOutput
func (*AuthorizationRule) ToAuthorizationRuleOutputWithContext ¶
func (i *AuthorizationRule) ToAuthorizationRuleOutputWithContext(ctx context.Context) AuthorizationRuleOutput
func (*AuthorizationRule) ToAuthorizationRulePtrOutput ¶
func (i *AuthorizationRule) ToAuthorizationRulePtrOutput() AuthorizationRulePtrOutput
func (*AuthorizationRule) ToAuthorizationRulePtrOutputWithContext ¶
func (i *AuthorizationRule) ToAuthorizationRulePtrOutputWithContext(ctx context.Context) AuthorizationRulePtrOutput
type AuthorizationRuleArgs ¶
type AuthorizationRuleArgs struct { // The ID of the group to which the authorization rule grants access. One of `accessGroupId` or `authorizeAllGroups` must be set. AccessGroupId pulumi.StringPtrInput // Indicates whether the authorization rule grants access to all clients. One of `accessGroupId` or `authorizeAllGroups` must be set. AuthorizeAllGroups pulumi.BoolPtrInput // The ID of the Client VPN endpoint. ClientVpnEndpointId pulumi.StringInput // A brief description of the authorization rule. Description pulumi.StringPtrInput // The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. TargetNetworkCidr pulumi.StringInput }
The set of arguments for constructing a AuthorizationRule resource.
func (AuthorizationRuleArgs) ElementType ¶
func (AuthorizationRuleArgs) ElementType() reflect.Type
type AuthorizationRuleArray ¶
type AuthorizationRuleArray []AuthorizationRuleInput
func (AuthorizationRuleArray) ElementType ¶
func (AuthorizationRuleArray) ElementType() reflect.Type
func (AuthorizationRuleArray) ToAuthorizationRuleArrayOutput ¶
func (i AuthorizationRuleArray) ToAuthorizationRuleArrayOutput() AuthorizationRuleArrayOutput
func (AuthorizationRuleArray) ToAuthorizationRuleArrayOutputWithContext ¶
func (i AuthorizationRuleArray) ToAuthorizationRuleArrayOutputWithContext(ctx context.Context) AuthorizationRuleArrayOutput
type AuthorizationRuleArrayInput ¶
type AuthorizationRuleArrayInput interface { pulumi.Input ToAuthorizationRuleArrayOutput() AuthorizationRuleArrayOutput ToAuthorizationRuleArrayOutputWithContext(context.Context) AuthorizationRuleArrayOutput }
AuthorizationRuleArrayInput is an input type that accepts AuthorizationRuleArray and AuthorizationRuleArrayOutput values. You can construct a concrete instance of `AuthorizationRuleArrayInput` via:
AuthorizationRuleArray{ AuthorizationRuleArgs{...} }
type AuthorizationRuleArrayOutput ¶
type AuthorizationRuleArrayOutput struct{ *pulumi.OutputState }
func (AuthorizationRuleArrayOutput) ElementType ¶
func (AuthorizationRuleArrayOutput) ElementType() reflect.Type
func (AuthorizationRuleArrayOutput) Index ¶
func (o AuthorizationRuleArrayOutput) Index(i pulumi.IntInput) AuthorizationRuleOutput
func (AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutput ¶
func (o AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutput() AuthorizationRuleArrayOutput
func (AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutputWithContext ¶
func (o AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutputWithContext(ctx context.Context) AuthorizationRuleArrayOutput
type AuthorizationRuleInput ¶
type AuthorizationRuleInput interface { pulumi.Input ToAuthorizationRuleOutput() AuthorizationRuleOutput ToAuthorizationRuleOutputWithContext(ctx context.Context) AuthorizationRuleOutput }
type AuthorizationRuleMap ¶
type AuthorizationRuleMap map[string]AuthorizationRuleInput
func (AuthorizationRuleMap) ElementType ¶
func (AuthorizationRuleMap) ElementType() reflect.Type
func (AuthorizationRuleMap) ToAuthorizationRuleMapOutput ¶
func (i AuthorizationRuleMap) ToAuthorizationRuleMapOutput() AuthorizationRuleMapOutput
func (AuthorizationRuleMap) ToAuthorizationRuleMapOutputWithContext ¶
func (i AuthorizationRuleMap) ToAuthorizationRuleMapOutputWithContext(ctx context.Context) AuthorizationRuleMapOutput
type AuthorizationRuleMapInput ¶
type AuthorizationRuleMapInput interface { pulumi.Input ToAuthorizationRuleMapOutput() AuthorizationRuleMapOutput ToAuthorizationRuleMapOutputWithContext(context.Context) AuthorizationRuleMapOutput }
AuthorizationRuleMapInput is an input type that accepts AuthorizationRuleMap and AuthorizationRuleMapOutput values. You can construct a concrete instance of `AuthorizationRuleMapInput` via:
AuthorizationRuleMap{ "key": AuthorizationRuleArgs{...} }
type AuthorizationRuleMapOutput ¶
type AuthorizationRuleMapOutput struct{ *pulumi.OutputState }
func (AuthorizationRuleMapOutput) ElementType ¶
func (AuthorizationRuleMapOutput) ElementType() reflect.Type
func (AuthorizationRuleMapOutput) MapIndex ¶
func (o AuthorizationRuleMapOutput) MapIndex(k pulumi.StringInput) AuthorizationRuleOutput
func (AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutput ¶
func (o AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutput() AuthorizationRuleMapOutput
func (AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutputWithContext ¶
func (o AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutputWithContext(ctx context.Context) AuthorizationRuleMapOutput
type AuthorizationRuleOutput ¶
type AuthorizationRuleOutput struct {
*pulumi.OutputState
}
func (AuthorizationRuleOutput) ElementType ¶
func (AuthorizationRuleOutput) ElementType() reflect.Type
func (AuthorizationRuleOutput) ToAuthorizationRuleOutput ¶
func (o AuthorizationRuleOutput) ToAuthorizationRuleOutput() AuthorizationRuleOutput
func (AuthorizationRuleOutput) ToAuthorizationRuleOutputWithContext ¶
func (o AuthorizationRuleOutput) ToAuthorizationRuleOutputWithContext(ctx context.Context) AuthorizationRuleOutput
func (AuthorizationRuleOutput) ToAuthorizationRulePtrOutput ¶
func (o AuthorizationRuleOutput) ToAuthorizationRulePtrOutput() AuthorizationRulePtrOutput
func (AuthorizationRuleOutput) ToAuthorizationRulePtrOutputWithContext ¶
func (o AuthorizationRuleOutput) ToAuthorizationRulePtrOutputWithContext(ctx context.Context) AuthorizationRulePtrOutput
type AuthorizationRulePtrInput ¶
type AuthorizationRulePtrInput interface { pulumi.Input ToAuthorizationRulePtrOutput() AuthorizationRulePtrOutput ToAuthorizationRulePtrOutputWithContext(ctx context.Context) AuthorizationRulePtrOutput }
type AuthorizationRulePtrOutput ¶
type AuthorizationRulePtrOutput struct {
*pulumi.OutputState
}
func (AuthorizationRulePtrOutput) ElementType ¶
func (AuthorizationRulePtrOutput) ElementType() reflect.Type
func (AuthorizationRulePtrOutput) ToAuthorizationRulePtrOutput ¶
func (o AuthorizationRulePtrOutput) ToAuthorizationRulePtrOutput() AuthorizationRulePtrOutput
func (AuthorizationRulePtrOutput) ToAuthorizationRulePtrOutputWithContext ¶
func (o AuthorizationRulePtrOutput) ToAuthorizationRulePtrOutputWithContext(ctx context.Context) AuthorizationRulePtrOutput
type AuthorizationRuleState ¶
type AuthorizationRuleState struct { // The ID of the group to which the authorization rule grants access. One of `accessGroupId` or `authorizeAllGroups` must be set. AccessGroupId pulumi.StringPtrInput // Indicates whether the authorization rule grants access to all clients. One of `accessGroupId` or `authorizeAllGroups` must be set. AuthorizeAllGroups pulumi.BoolPtrInput // The ID of the Client VPN endpoint. ClientVpnEndpointId pulumi.StringPtrInput // A brief description of the authorization rule. Description pulumi.StringPtrInput // The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. TargetNetworkCidr pulumi.StringPtrInput }
func (AuthorizationRuleState) ElementType ¶
func (AuthorizationRuleState) ElementType() reflect.Type
type Endpoint ¶
type Endpoint struct { pulumi.CustomResourceState // The ARN of the Client VPN endpoint. Arn pulumi.StringOutput `pulumi:"arn"` // Information about the authentication method to be used to authenticate clients. AuthenticationOptions EndpointAuthenticationOptionArrayOutput `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"` Tags pulumi.StringMapOutput `pulumi:"tags"` TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` // 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).
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2clientvpn" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := ec2clientvpn.NewEndpoint(ctx, "example", &ec2clientvpn.EndpointArgs{ Description: pulumi.String("clientvpn-example"), ServerCertificateArn: pulumi.Any(aws_acm_certificate.Cert.Arn), ClientCidrBlock: pulumi.String("10.0.0.0/16"), AuthenticationOptions: ec2clientvpn.EndpointAuthenticationOptionArray{ &ec2clientvpn.EndpointAuthenticationOptionArgs{ Type: pulumi.String("certificate-authentication"), RootCertificateChainArn: pulumi.Any(aws_acm_certificate.Root_cert.Arn), }, }, ConnectionLogOptions: &ec2clientvpn.EndpointConnectionLogOptionsArgs{ Enabled: pulumi.Bool(true), CloudwatchLogGroup: pulumi.Any(aws_cloudwatch_log_group.Lg.Name), CloudwatchLogStream: pulumi.Any(aws_cloudwatch_log_stream.Ls.Name), }, }) if err != nil { return err } return nil }) }
```
## Import
AWS Client VPN endpoints can be imported using the `id` value found via `aws ec2 describe-client-vpn-endpoints`, e.g.
```sh
$ pulumi import aws:ec2clientvpn/endpoint:Endpoint example cvpn-endpoint-0ac3a1abbccddd666
```
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.
func (*Endpoint) ElementType ¶
func (*Endpoint) ToEndpointOutput ¶
func (i *Endpoint) ToEndpointOutput() EndpointOutput
func (*Endpoint) ToEndpointOutputWithContext ¶
func (i *Endpoint) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput
func (*Endpoint) ToEndpointPtrOutput ¶
func (i *Endpoint) ToEndpointPtrOutput() EndpointPtrOutput
func (*Endpoint) ToEndpointPtrOutputWithContext ¶
func (i *Endpoint) ToEndpointPtrOutputWithContext(ctx context.Context) EndpointPtrOutput
type EndpointArgs ¶
type EndpointArgs struct { // Information about the authentication method to be used to authenticate clients. AuthenticationOptions EndpointAuthenticationOptionArrayInput // 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 Tags pulumi.StringMapInput TagsAll pulumi.StringMapInput // 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 EndpointArray ¶
type EndpointArray []EndpointInput
func (EndpointArray) ElementType ¶
func (EndpointArray) ElementType() reflect.Type
func (EndpointArray) ToEndpointArrayOutput ¶
func (i EndpointArray) ToEndpointArrayOutput() EndpointArrayOutput
func (EndpointArray) ToEndpointArrayOutputWithContext ¶
func (i EndpointArray) ToEndpointArrayOutputWithContext(ctx context.Context) EndpointArrayOutput
type EndpointArrayInput ¶
type EndpointArrayInput interface { pulumi.Input ToEndpointArrayOutput() EndpointArrayOutput ToEndpointArrayOutputWithContext(context.Context) EndpointArrayOutput }
EndpointArrayInput is an input type that accepts EndpointArray and EndpointArrayOutput values. You can construct a concrete instance of `EndpointArrayInput` via:
EndpointArray{ EndpointArgs{...} }
type EndpointArrayOutput ¶
type EndpointArrayOutput struct{ *pulumi.OutputState }
func (EndpointArrayOutput) ElementType ¶
func (EndpointArrayOutput) ElementType() reflect.Type
func (EndpointArrayOutput) Index ¶
func (o EndpointArrayOutput) Index(i pulumi.IntInput) EndpointOutput
func (EndpointArrayOutput) ToEndpointArrayOutput ¶
func (o EndpointArrayOutput) ToEndpointArrayOutput() EndpointArrayOutput
func (EndpointArrayOutput) ToEndpointArrayOutputWithContext ¶
func (o EndpointArrayOutput) ToEndpointArrayOutputWithContext(ctx context.Context) EndpointArrayOutput
type EndpointAuthenticationOption ¶
type EndpointAuthenticationOption 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 ARN of the IAM SAML identity provider if type is `federated-authentication`. SamlProviderArn *string `pulumi:"samlProviderArn"` // The type of client authentication to be used. Specify `certificate-authentication` to use certificate-based authentication, `directory-service-authentication` to use Active Directory authentication, or `federated-authentication` to use Federated Authentication via SAML 2.0. Type string `pulumi:"type"` }
type EndpointAuthenticationOptionArgs ¶
type EndpointAuthenticationOptionArgs 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 ARN of the IAM SAML identity provider if type is `federated-authentication`. SamlProviderArn pulumi.StringPtrInput `pulumi:"samlProviderArn"` // The type of client authentication to be used. Specify `certificate-authentication` to use certificate-based authentication, `directory-service-authentication` to use Active Directory authentication, or `federated-authentication` to use Federated Authentication via SAML 2.0. Type pulumi.StringInput `pulumi:"type"` }
func (EndpointAuthenticationOptionArgs) ElementType ¶
func (EndpointAuthenticationOptionArgs) ElementType() reflect.Type
func (EndpointAuthenticationOptionArgs) ToEndpointAuthenticationOptionOutput ¶
func (i EndpointAuthenticationOptionArgs) ToEndpointAuthenticationOptionOutput() EndpointAuthenticationOptionOutput
func (EndpointAuthenticationOptionArgs) ToEndpointAuthenticationOptionOutputWithContext ¶
func (i EndpointAuthenticationOptionArgs) ToEndpointAuthenticationOptionOutputWithContext(ctx context.Context) EndpointAuthenticationOptionOutput
type EndpointAuthenticationOptionArray ¶
type EndpointAuthenticationOptionArray []EndpointAuthenticationOptionInput
func (EndpointAuthenticationOptionArray) ElementType ¶
func (EndpointAuthenticationOptionArray) ElementType() reflect.Type
func (EndpointAuthenticationOptionArray) ToEndpointAuthenticationOptionArrayOutput ¶
func (i EndpointAuthenticationOptionArray) ToEndpointAuthenticationOptionArrayOutput() EndpointAuthenticationOptionArrayOutput
func (EndpointAuthenticationOptionArray) ToEndpointAuthenticationOptionArrayOutputWithContext ¶
func (i EndpointAuthenticationOptionArray) ToEndpointAuthenticationOptionArrayOutputWithContext(ctx context.Context) EndpointAuthenticationOptionArrayOutput
type EndpointAuthenticationOptionArrayInput ¶
type EndpointAuthenticationOptionArrayInput interface { pulumi.Input ToEndpointAuthenticationOptionArrayOutput() EndpointAuthenticationOptionArrayOutput ToEndpointAuthenticationOptionArrayOutputWithContext(context.Context) EndpointAuthenticationOptionArrayOutput }
EndpointAuthenticationOptionArrayInput is an input type that accepts EndpointAuthenticationOptionArray and EndpointAuthenticationOptionArrayOutput values. You can construct a concrete instance of `EndpointAuthenticationOptionArrayInput` via:
EndpointAuthenticationOptionArray{ EndpointAuthenticationOptionArgs{...} }
type EndpointAuthenticationOptionArrayOutput ¶
type EndpointAuthenticationOptionArrayOutput struct{ *pulumi.OutputState }
func (EndpointAuthenticationOptionArrayOutput) ElementType ¶
func (EndpointAuthenticationOptionArrayOutput) ElementType() reflect.Type
func (EndpointAuthenticationOptionArrayOutput) ToEndpointAuthenticationOptionArrayOutput ¶
func (o EndpointAuthenticationOptionArrayOutput) ToEndpointAuthenticationOptionArrayOutput() EndpointAuthenticationOptionArrayOutput
func (EndpointAuthenticationOptionArrayOutput) ToEndpointAuthenticationOptionArrayOutputWithContext ¶
func (o EndpointAuthenticationOptionArrayOutput) ToEndpointAuthenticationOptionArrayOutputWithContext(ctx context.Context) EndpointAuthenticationOptionArrayOutput
type EndpointAuthenticationOptionInput ¶
type EndpointAuthenticationOptionInput interface { pulumi.Input ToEndpointAuthenticationOptionOutput() EndpointAuthenticationOptionOutput ToEndpointAuthenticationOptionOutputWithContext(context.Context) EndpointAuthenticationOptionOutput }
EndpointAuthenticationOptionInput is an input type that accepts EndpointAuthenticationOptionArgs and EndpointAuthenticationOptionOutput values. You can construct a concrete instance of `EndpointAuthenticationOptionInput` via:
EndpointAuthenticationOptionArgs{...}
type EndpointAuthenticationOptionOutput ¶
type EndpointAuthenticationOptionOutput struct{ *pulumi.OutputState }
func (EndpointAuthenticationOptionOutput) ActiveDirectoryId ¶
func (o EndpointAuthenticationOptionOutput) ActiveDirectoryId() pulumi.StringPtrOutput
The ID of the Active Directory to be used for authentication if type is `directory-service-authentication`.
func (EndpointAuthenticationOptionOutput) ElementType ¶
func (EndpointAuthenticationOptionOutput) ElementType() reflect.Type
func (EndpointAuthenticationOptionOutput) RootCertificateChainArn ¶
func (o EndpointAuthenticationOptionOutput) 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 (EndpointAuthenticationOptionOutput) SamlProviderArn ¶
func (o EndpointAuthenticationOptionOutput) SamlProviderArn() pulumi.StringPtrOutput
The ARN of the IAM SAML identity provider if type is `federated-authentication`.
func (EndpointAuthenticationOptionOutput) ToEndpointAuthenticationOptionOutput ¶
func (o EndpointAuthenticationOptionOutput) ToEndpointAuthenticationOptionOutput() EndpointAuthenticationOptionOutput
func (EndpointAuthenticationOptionOutput) ToEndpointAuthenticationOptionOutputWithContext ¶
func (o EndpointAuthenticationOptionOutput) ToEndpointAuthenticationOptionOutputWithContext(ctx context.Context) EndpointAuthenticationOptionOutput
func (EndpointAuthenticationOptionOutput) Type ¶
func (o EndpointAuthenticationOptionOutput) Type() pulumi.StringOutput
The type of client authentication to be used. Specify `certificate-authentication` to use certificate-based authentication, `directory-service-authentication` to use Active Directory authentication, or `federated-authentication` to use Federated Authentication via SAML 2.0.
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 }
EndpointConnectionLogOptionsInput is an input type that accepts EndpointConnectionLogOptionsArgs and EndpointConnectionLogOptionsOutput values. You can construct a concrete instance of `EndpointConnectionLogOptionsInput` via:
EndpointConnectionLogOptionsArgs{...}
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 }
EndpointConnectionLogOptionsPtrInput is an input type that accepts EndpointConnectionLogOptionsArgs, EndpointConnectionLogOptionsPtr and EndpointConnectionLogOptionsPtrOutput values. You can construct a concrete instance of `EndpointConnectionLogOptionsPtrInput` via:
EndpointConnectionLogOptionsArgs{...} or: nil
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) ElementType ¶
func (EndpointConnectionLogOptionsPtrOutput) ElementType() reflect.Type
func (EndpointConnectionLogOptionsPtrOutput) Enabled ¶
func (o EndpointConnectionLogOptionsPtrOutput) Enabled() pulumi.BoolPtrOutput
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 EndpointInput ¶
type EndpointInput interface { pulumi.Input ToEndpointOutput() EndpointOutput ToEndpointOutputWithContext(ctx context.Context) EndpointOutput }
type EndpointMap ¶
type EndpointMap map[string]EndpointInput
func (EndpointMap) ElementType ¶
func (EndpointMap) ElementType() reflect.Type
func (EndpointMap) ToEndpointMapOutput ¶
func (i EndpointMap) ToEndpointMapOutput() EndpointMapOutput
func (EndpointMap) ToEndpointMapOutputWithContext ¶
func (i EndpointMap) ToEndpointMapOutputWithContext(ctx context.Context) EndpointMapOutput
type EndpointMapInput ¶
type EndpointMapInput interface { pulumi.Input ToEndpointMapOutput() EndpointMapOutput ToEndpointMapOutputWithContext(context.Context) EndpointMapOutput }
EndpointMapInput is an input type that accepts EndpointMap and EndpointMapOutput values. You can construct a concrete instance of `EndpointMapInput` via:
EndpointMap{ "key": EndpointArgs{...} }
type EndpointMapOutput ¶
type EndpointMapOutput struct{ *pulumi.OutputState }
func (EndpointMapOutput) ElementType ¶
func (EndpointMapOutput) ElementType() reflect.Type
func (EndpointMapOutput) MapIndex ¶
func (o EndpointMapOutput) MapIndex(k pulumi.StringInput) EndpointOutput
func (EndpointMapOutput) ToEndpointMapOutput ¶
func (o EndpointMapOutput) ToEndpointMapOutput() EndpointMapOutput
func (EndpointMapOutput) ToEndpointMapOutputWithContext ¶
func (o EndpointMapOutput) ToEndpointMapOutputWithContext(ctx context.Context) EndpointMapOutput
type EndpointOutput ¶
type EndpointOutput struct {
*pulumi.OutputState
}
func (EndpointOutput) ElementType ¶
func (EndpointOutput) ElementType() reflect.Type
func (EndpointOutput) ToEndpointOutput ¶
func (o EndpointOutput) ToEndpointOutput() EndpointOutput
func (EndpointOutput) ToEndpointOutputWithContext ¶
func (o EndpointOutput) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput
func (EndpointOutput) ToEndpointPtrOutput ¶
func (o EndpointOutput) ToEndpointPtrOutput() EndpointPtrOutput
func (EndpointOutput) ToEndpointPtrOutputWithContext ¶
func (o EndpointOutput) ToEndpointPtrOutputWithContext(ctx context.Context) EndpointPtrOutput
type EndpointPtrInput ¶
type EndpointPtrInput interface { pulumi.Input ToEndpointPtrOutput() EndpointPtrOutput ToEndpointPtrOutputWithContext(ctx context.Context) EndpointPtrOutput }
type EndpointPtrOutput ¶
type EndpointPtrOutput struct {
*pulumi.OutputState
}
func (EndpointPtrOutput) ElementType ¶
func (EndpointPtrOutput) ElementType() reflect.Type
func (EndpointPtrOutput) ToEndpointPtrOutput ¶
func (o EndpointPtrOutput) ToEndpointPtrOutput() EndpointPtrOutput
func (EndpointPtrOutput) ToEndpointPtrOutputWithContext ¶
func (o EndpointPtrOutput) ToEndpointPtrOutputWithContext(ctx context.Context) EndpointPtrOutput
type EndpointState ¶
type EndpointState struct { // The ARN of the Client VPN endpoint. Arn pulumi.StringPtrInput // Information about the authentication method to be used to authenticate clients. AuthenticationOptions EndpointAuthenticationOptionArrayInput // 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 Tags pulumi.StringMapInput TagsAll pulumi.StringMapInput // 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 unique ID of the target network association. AssociationId pulumi.StringOutput `pulumi:"associationId"` // The ID of the Client VPN endpoint. ClientVpnEndpointId pulumi.StringOutput `pulumi:"clientVpnEndpointId"` // A list of up to five custom security groups to apply to the target network. If not specified, the VPC's default security group is assigned. 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 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).
## Example Usage ### Using default security group
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2clientvpn" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := ec2clientvpn.NewNetworkAssociation(ctx, "example", &ec2clientvpn.NetworkAssociationArgs{ ClientVpnEndpointId: pulumi.Any(aws_ec2_client_vpn_endpoint.Example.Id), SubnetId: pulumi.Any(aws_subnet.Example.Id), }) if err != nil { return err } return nil }) }
```
## Import
AWS Client VPN network associations can be imported using the endpoint ID and the association ID. Values are separated by a `,`.
```sh
$ pulumi import aws:ec2clientvpn/networkAssociation:NetworkAssociation example cvpn-endpoint-0ac3a1abbccddd666,vpn-assoc-0b8db902465d069ad
```
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.
func (*NetworkAssociation) ElementType ¶
func (*NetworkAssociation) ElementType() reflect.Type
func (*NetworkAssociation) ToNetworkAssociationOutput ¶
func (i *NetworkAssociation) ToNetworkAssociationOutput() NetworkAssociationOutput
func (*NetworkAssociation) ToNetworkAssociationOutputWithContext ¶
func (i *NetworkAssociation) ToNetworkAssociationOutputWithContext(ctx context.Context) NetworkAssociationOutput
func (*NetworkAssociation) ToNetworkAssociationPtrOutput ¶
func (i *NetworkAssociation) ToNetworkAssociationPtrOutput() NetworkAssociationPtrOutput
func (*NetworkAssociation) ToNetworkAssociationPtrOutputWithContext ¶
func (i *NetworkAssociation) ToNetworkAssociationPtrOutputWithContext(ctx context.Context) NetworkAssociationPtrOutput
type NetworkAssociationArgs ¶
type NetworkAssociationArgs struct { // The ID of the Client VPN endpoint. ClientVpnEndpointId pulumi.StringInput // A list of up to five custom security groups to apply to the target network. If not specified, the VPC's default security group is assigned. SecurityGroups pulumi.StringArrayInput // 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 NetworkAssociationArray ¶
type NetworkAssociationArray []NetworkAssociationInput
func (NetworkAssociationArray) ElementType ¶
func (NetworkAssociationArray) ElementType() reflect.Type
func (NetworkAssociationArray) ToNetworkAssociationArrayOutput ¶
func (i NetworkAssociationArray) ToNetworkAssociationArrayOutput() NetworkAssociationArrayOutput
func (NetworkAssociationArray) ToNetworkAssociationArrayOutputWithContext ¶
func (i NetworkAssociationArray) ToNetworkAssociationArrayOutputWithContext(ctx context.Context) NetworkAssociationArrayOutput
type NetworkAssociationArrayInput ¶
type NetworkAssociationArrayInput interface { pulumi.Input ToNetworkAssociationArrayOutput() NetworkAssociationArrayOutput ToNetworkAssociationArrayOutputWithContext(context.Context) NetworkAssociationArrayOutput }
NetworkAssociationArrayInput is an input type that accepts NetworkAssociationArray and NetworkAssociationArrayOutput values. You can construct a concrete instance of `NetworkAssociationArrayInput` via:
NetworkAssociationArray{ NetworkAssociationArgs{...} }
type NetworkAssociationArrayOutput ¶
type NetworkAssociationArrayOutput struct{ *pulumi.OutputState }
func (NetworkAssociationArrayOutput) ElementType ¶
func (NetworkAssociationArrayOutput) ElementType() reflect.Type
func (NetworkAssociationArrayOutput) Index ¶
func (o NetworkAssociationArrayOutput) Index(i pulumi.IntInput) NetworkAssociationOutput
func (NetworkAssociationArrayOutput) ToNetworkAssociationArrayOutput ¶
func (o NetworkAssociationArrayOutput) ToNetworkAssociationArrayOutput() NetworkAssociationArrayOutput
func (NetworkAssociationArrayOutput) ToNetworkAssociationArrayOutputWithContext ¶
func (o NetworkAssociationArrayOutput) ToNetworkAssociationArrayOutputWithContext(ctx context.Context) NetworkAssociationArrayOutput
type NetworkAssociationInput ¶
type NetworkAssociationInput interface { pulumi.Input ToNetworkAssociationOutput() NetworkAssociationOutput ToNetworkAssociationOutputWithContext(ctx context.Context) NetworkAssociationOutput }
type NetworkAssociationMap ¶
type NetworkAssociationMap map[string]NetworkAssociationInput
func (NetworkAssociationMap) ElementType ¶
func (NetworkAssociationMap) ElementType() reflect.Type
func (NetworkAssociationMap) ToNetworkAssociationMapOutput ¶
func (i NetworkAssociationMap) ToNetworkAssociationMapOutput() NetworkAssociationMapOutput
func (NetworkAssociationMap) ToNetworkAssociationMapOutputWithContext ¶
func (i NetworkAssociationMap) ToNetworkAssociationMapOutputWithContext(ctx context.Context) NetworkAssociationMapOutput
type NetworkAssociationMapInput ¶
type NetworkAssociationMapInput interface { pulumi.Input ToNetworkAssociationMapOutput() NetworkAssociationMapOutput ToNetworkAssociationMapOutputWithContext(context.Context) NetworkAssociationMapOutput }
NetworkAssociationMapInput is an input type that accepts NetworkAssociationMap and NetworkAssociationMapOutput values. You can construct a concrete instance of `NetworkAssociationMapInput` via:
NetworkAssociationMap{ "key": NetworkAssociationArgs{...} }
type NetworkAssociationMapOutput ¶
type NetworkAssociationMapOutput struct{ *pulumi.OutputState }
func (NetworkAssociationMapOutput) ElementType ¶
func (NetworkAssociationMapOutput) ElementType() reflect.Type
func (NetworkAssociationMapOutput) MapIndex ¶
func (o NetworkAssociationMapOutput) MapIndex(k pulumi.StringInput) NetworkAssociationOutput
func (NetworkAssociationMapOutput) ToNetworkAssociationMapOutput ¶
func (o NetworkAssociationMapOutput) ToNetworkAssociationMapOutput() NetworkAssociationMapOutput
func (NetworkAssociationMapOutput) ToNetworkAssociationMapOutputWithContext ¶
func (o NetworkAssociationMapOutput) ToNetworkAssociationMapOutputWithContext(ctx context.Context) NetworkAssociationMapOutput
type NetworkAssociationOutput ¶
type NetworkAssociationOutput struct {
*pulumi.OutputState
}
func (NetworkAssociationOutput) ElementType ¶
func (NetworkAssociationOutput) ElementType() reflect.Type
func (NetworkAssociationOutput) ToNetworkAssociationOutput ¶
func (o NetworkAssociationOutput) ToNetworkAssociationOutput() NetworkAssociationOutput
func (NetworkAssociationOutput) ToNetworkAssociationOutputWithContext ¶
func (o NetworkAssociationOutput) ToNetworkAssociationOutputWithContext(ctx context.Context) NetworkAssociationOutput
func (NetworkAssociationOutput) ToNetworkAssociationPtrOutput ¶
func (o NetworkAssociationOutput) ToNetworkAssociationPtrOutput() NetworkAssociationPtrOutput
func (NetworkAssociationOutput) ToNetworkAssociationPtrOutputWithContext ¶
func (o NetworkAssociationOutput) ToNetworkAssociationPtrOutputWithContext(ctx context.Context) NetworkAssociationPtrOutput
type NetworkAssociationPtrInput ¶
type NetworkAssociationPtrInput interface { pulumi.Input ToNetworkAssociationPtrOutput() NetworkAssociationPtrOutput ToNetworkAssociationPtrOutputWithContext(ctx context.Context) NetworkAssociationPtrOutput }
type NetworkAssociationPtrOutput ¶
type NetworkAssociationPtrOutput struct {
*pulumi.OutputState
}
func (NetworkAssociationPtrOutput) ElementType ¶
func (NetworkAssociationPtrOutput) ElementType() reflect.Type
func (NetworkAssociationPtrOutput) ToNetworkAssociationPtrOutput ¶
func (o NetworkAssociationPtrOutput) ToNetworkAssociationPtrOutput() NetworkAssociationPtrOutput
func (NetworkAssociationPtrOutput) ToNetworkAssociationPtrOutputWithContext ¶
func (o NetworkAssociationPtrOutput) ToNetworkAssociationPtrOutputWithContext(ctx context.Context) NetworkAssociationPtrOutput
type NetworkAssociationState ¶
type NetworkAssociationState struct { // The unique ID of the target network association. AssociationId pulumi.StringPtrInput // The ID of the Client VPN endpoint. ClientVpnEndpointId pulumi.StringPtrInput // A list of up to five custom security groups to apply to the target network. If not specified, the VPC's default security group is assigned. 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 subnet is located. VpcId pulumi.StringPtrInput }
func (NetworkAssociationState) ElementType ¶
func (NetworkAssociationState) ElementType() reflect.Type
type Route ¶
type Route struct { pulumi.CustomResourceState // The ID of the Client VPN endpoint. ClientVpnEndpointId pulumi.StringOutput `pulumi:"clientVpnEndpointId"` // A brief description of the authorization rule. Description pulumi.StringPtrOutput `pulumi:"description"` // The IPv4 address range, in CIDR notation, of the route destination. DestinationCidrBlock pulumi.StringOutput `pulumi:"destinationCidrBlock"` // Indicates how the Client VPN route was added. Will be `add-route` for routes created by this resource. Origin pulumi.StringOutput `pulumi:"origin"` // The ID of the Subnet to route the traffic through. It must already be attached to the Client VPN. TargetVpcSubnetId pulumi.StringOutput `pulumi:"targetVpcSubnetId"` // The type of the route. Type pulumi.StringOutput `pulumi:"type"` }
Provides additional routes 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).
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2clientvpn" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleEndpoint, err := ec2clientvpn.NewEndpoint(ctx, "exampleEndpoint", &ec2clientvpn.EndpointArgs{ Description: pulumi.String("Example Client VPN endpoint"), ServerCertificateArn: pulumi.Any(aws_acm_certificate.Example.Arn), ClientCidrBlock: pulumi.String("10.0.0.0/16"), AuthenticationOptions: ec2clientvpn.EndpointAuthenticationOptionArray{ &ec2clientvpn.EndpointAuthenticationOptionArgs{ Type: pulumi.String("certificate-authentication"), RootCertificateChainArn: pulumi.Any(aws_acm_certificate.Example.Arn), }, }, ConnectionLogOptions: &ec2clientvpn.EndpointConnectionLogOptionsArgs{ Enabled: pulumi.Bool(false), }, }) if err != nil { return err } exampleNetworkAssociation, err := ec2clientvpn.NewNetworkAssociation(ctx, "exampleNetworkAssociation", &ec2clientvpn.NetworkAssociationArgs{ ClientVpnEndpointId: exampleEndpoint.ID(), SubnetId: pulumi.Any(aws_subnet.Example.Id), }) if err != nil { return err } _, err = ec2clientvpn.NewRoute(ctx, "exampleRoute", &ec2clientvpn.RouteArgs{ ClientVpnEndpointId: exampleEndpoint.ID(), DestinationCidrBlock: pulumi.String("0.0.0.0/0"), TargetVpcSubnetId: exampleNetworkAssociation.SubnetId, }) if err != nil { return err } return nil }) }
```
## Import
AWS Client VPN routes can be imported using the endpoint ID, target subnet ID, and destination CIDR block. All values are separated by a `,`.
```sh
$ pulumi import aws:ec2clientvpn/route:Route example cvpn-endpoint-1234567890abcdef,subnet-9876543210fedcba,10.1.0.0/24
```
func GetRoute ¶
func GetRoute(ctx *pulumi.Context, name string, id pulumi.IDInput, state *RouteState, opts ...pulumi.ResourceOption) (*Route, error)
GetRoute gets an existing Route 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 NewRoute ¶
func NewRoute(ctx *pulumi.Context, name string, args *RouteArgs, opts ...pulumi.ResourceOption) (*Route, error)
NewRoute registers a new resource with the given unique name, arguments, and options.
func (*Route) ElementType ¶
func (*Route) ToRouteOutput ¶
func (i *Route) ToRouteOutput() RouteOutput
func (*Route) ToRouteOutputWithContext ¶
func (i *Route) ToRouteOutputWithContext(ctx context.Context) RouteOutput
func (*Route) ToRoutePtrOutput ¶
func (i *Route) ToRoutePtrOutput() RoutePtrOutput
func (*Route) ToRoutePtrOutputWithContext ¶
func (i *Route) ToRoutePtrOutputWithContext(ctx context.Context) RoutePtrOutput
type RouteArgs ¶
type RouteArgs struct { // The ID of the Client VPN endpoint. ClientVpnEndpointId pulumi.StringInput // A brief description of the authorization rule. Description pulumi.StringPtrInput // The IPv4 address range, in CIDR notation, of the route destination. DestinationCidrBlock pulumi.StringInput // The ID of the Subnet to route the traffic through. It must already be attached to the Client VPN. TargetVpcSubnetId pulumi.StringInput }
The set of arguments for constructing a Route resource.
func (RouteArgs) ElementType ¶
type RouteArray ¶
type RouteArray []RouteInput
func (RouteArray) ElementType ¶
func (RouteArray) ElementType() reflect.Type
func (RouteArray) ToRouteArrayOutput ¶
func (i RouteArray) ToRouteArrayOutput() RouteArrayOutput
func (RouteArray) ToRouteArrayOutputWithContext ¶
func (i RouteArray) ToRouteArrayOutputWithContext(ctx context.Context) RouteArrayOutput
type RouteArrayInput ¶
type RouteArrayInput interface { pulumi.Input ToRouteArrayOutput() RouteArrayOutput ToRouteArrayOutputWithContext(context.Context) RouteArrayOutput }
RouteArrayInput is an input type that accepts RouteArray and RouteArrayOutput values. You can construct a concrete instance of `RouteArrayInput` via:
RouteArray{ RouteArgs{...} }
type RouteArrayOutput ¶
type RouteArrayOutput struct{ *pulumi.OutputState }
func (RouteArrayOutput) ElementType ¶
func (RouteArrayOutput) ElementType() reflect.Type
func (RouteArrayOutput) Index ¶
func (o RouteArrayOutput) Index(i pulumi.IntInput) RouteOutput
func (RouteArrayOutput) ToRouteArrayOutput ¶
func (o RouteArrayOutput) ToRouteArrayOutput() RouteArrayOutput
func (RouteArrayOutput) ToRouteArrayOutputWithContext ¶
func (o RouteArrayOutput) ToRouteArrayOutputWithContext(ctx context.Context) RouteArrayOutput
type RouteInput ¶
type RouteInput interface { pulumi.Input ToRouteOutput() RouteOutput ToRouteOutputWithContext(ctx context.Context) RouteOutput }
type RouteMap ¶
type RouteMap map[string]RouteInput
func (RouteMap) ElementType ¶
func (RouteMap) ToRouteMapOutput ¶
func (i RouteMap) ToRouteMapOutput() RouteMapOutput
func (RouteMap) ToRouteMapOutputWithContext ¶
func (i RouteMap) ToRouteMapOutputWithContext(ctx context.Context) RouteMapOutput
type RouteMapInput ¶
type RouteMapInput interface { pulumi.Input ToRouteMapOutput() RouteMapOutput ToRouteMapOutputWithContext(context.Context) RouteMapOutput }
RouteMapInput is an input type that accepts RouteMap and RouteMapOutput values. You can construct a concrete instance of `RouteMapInput` via:
RouteMap{ "key": RouteArgs{...} }
type RouteMapOutput ¶
type RouteMapOutput struct{ *pulumi.OutputState }
func (RouteMapOutput) ElementType ¶
func (RouteMapOutput) ElementType() reflect.Type
func (RouteMapOutput) MapIndex ¶
func (o RouteMapOutput) MapIndex(k pulumi.StringInput) RouteOutput
func (RouteMapOutput) ToRouteMapOutput ¶
func (o RouteMapOutput) ToRouteMapOutput() RouteMapOutput
func (RouteMapOutput) ToRouteMapOutputWithContext ¶
func (o RouteMapOutput) ToRouteMapOutputWithContext(ctx context.Context) RouteMapOutput
type RouteOutput ¶
type RouteOutput struct {
*pulumi.OutputState
}
func (RouteOutput) ElementType ¶
func (RouteOutput) ElementType() reflect.Type
func (RouteOutput) ToRouteOutput ¶
func (o RouteOutput) ToRouteOutput() RouteOutput
func (RouteOutput) ToRouteOutputWithContext ¶
func (o RouteOutput) ToRouteOutputWithContext(ctx context.Context) RouteOutput
func (RouteOutput) ToRoutePtrOutput ¶
func (o RouteOutput) ToRoutePtrOutput() RoutePtrOutput
func (RouteOutput) ToRoutePtrOutputWithContext ¶
func (o RouteOutput) ToRoutePtrOutputWithContext(ctx context.Context) RoutePtrOutput
type RoutePtrInput ¶
type RoutePtrInput interface { pulumi.Input ToRoutePtrOutput() RoutePtrOutput ToRoutePtrOutputWithContext(ctx context.Context) RoutePtrOutput }
type RoutePtrOutput ¶
type RoutePtrOutput struct {
*pulumi.OutputState
}
func (RoutePtrOutput) ElementType ¶
func (RoutePtrOutput) ElementType() reflect.Type
func (RoutePtrOutput) ToRoutePtrOutput ¶
func (o RoutePtrOutput) ToRoutePtrOutput() RoutePtrOutput
func (RoutePtrOutput) ToRoutePtrOutputWithContext ¶
func (o RoutePtrOutput) ToRoutePtrOutputWithContext(ctx context.Context) RoutePtrOutput
type RouteState ¶
type RouteState struct { // The ID of the Client VPN endpoint. ClientVpnEndpointId pulumi.StringPtrInput // A brief description of the authorization rule. Description pulumi.StringPtrInput // The IPv4 address range, in CIDR notation, of the route destination. DestinationCidrBlock pulumi.StringPtrInput // Indicates how the Client VPN route was added. Will be `add-route` for routes created by this resource. Origin pulumi.StringPtrInput // The ID of the Subnet to route the traffic through. It must already be attached to the Client VPN. TargetVpcSubnetId pulumi.StringPtrInput // The type of the route. Type pulumi.StringPtrInput }
func (RouteState) ElementType ¶
func (RouteState) ElementType() reflect.Type