VpcEndpointArgs class

The set of arguments for VpcEndpoint. The set of arguments for VpcEndpoint.

Constructors

VpcEndpointArgs({Input<bool?>? autoAccept, Input<VpcEndpointDnsOptions?>? dnsOptions, Input<String?>? ipAddressType, Input<String?>? policy, Input<bool?>? privateDnsEnabled, Input<String?>? region, Input<String?>? resourceConfigurationArn, Input<List<String>?>? routeTableIds, Input<List<String>?>? securityGroupIds, Input<String?>? serviceName, Input<String?>? serviceNetworkArn, Input<String?>? serviceRegion, Input<List<VpcEndpointSubnetConfiguration>?>? subnetConfigurations, Input<List<String>?>? subnetIds, Input<Map<String, String>?>? tags, Input<String?>? vpcEndpointType, required Input<String> vpcId})
Creates a new VpcEndpointArgs. autoAccept Accept the VPC endpoint (the VPC endpoint and service need to be in the same AWS account). dnsOptions The DNS options for the endpoint. See dnsOptions below. ipAddressType The IP address type for the endpoint. Valid values are ipv4, dualstack, and ipv6. policy A policy to attach to the endpoint that controls access to the service. This is a JSON formatted string. Defaults to full access. All Gateway and some Interface endpoints support policies - see the relevant AWS documentation for more details. privateDnsEnabled Whether or not to associate a private hosted zone with the specified VPC. Applicable for endpoints of type Interface. Most users will want this enabled to allow services within the VPC to automatically use the endpoint. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. resourceConfigurationArn The ARN of a Resource Configuration to connect this VPC Endpoint to. Exactly one of resourceConfigurationArn, serviceName or serviceNetworkArn is required. routeTableIds One or more route table IDs. Applicable for endpoints of type Gateway. securityGroupIds The ID of one or more security groups to associate with the network interface. Applicable for endpoints of type Interface. serviceName The service name. For AWS services the service name is usually in the form com.amazonaws.&lt;region&gt;.&lt;service&gt; (the SageMaker AI Notebook service is an exception to this rule, the service name is in the form aws.sagemaker.&lt;region&gt;.notebook). Exactly one of resourceConfigurationArn, serviceName or serviceNetworkArn is required. serviceNetworkArn The ARN of a Service Network to connect this VPC Endpoint to. Exactly one of resourceConfigurationArn, serviceName or serviceNetworkArn is required. serviceRegion The AWS region of the VPC Endpoint Service. If specified, the VPC endpoint will connect to the service in the provided region. Applicable for endpoints of type Interface. subnetConfigurations Subnet configuration for the endpoint, used to select specific IPv4 and/or IPv6 addresses to the endpoint. See subnetConfiguration below. subnetIds The ID of one or more subnets in which to create a network interface for the endpoint. Applicable for endpoints of type GatewayLoadBalancer and Interface. Interface type endpoints cannot function without being assigned to a subnet. tags A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. vpcEndpointType The VPC endpoint type, Gateway, GatewayLoadBalancer,Interface, Resource or ServiceNetwork. Defaults to Gateway. vpcId The ID of the VPC in which the endpoint will be used.
const
VpcEndpointArgs.fromMap(Map<String, dynamic> map)
factory

Properties

autoAccept → Input<bool?>?
Accept the VPC endpoint (the VPC endpoint and service need to be in the same AWS account).
final
dnsOptions → Input<VpcEndpointDnsOptions?>?
The DNS options for the endpoint. See dnsOptions below.
final
hashCode → int
The hash code for this object.
no setterinherited
ipAddressType → Input<String?>?
The IP address type for the endpoint. Valid values are ipv4, dualstack, and ipv6.
final
policy → Input<String?>?
A policy to attach to the endpoint that controls access to the service. This is a JSON formatted string. Defaults to full access. All Gateway and some Interface endpoints support policies - see the relevant AWS documentation for more details.
final
privateDnsEnabled → Input<bool?>?
Whether or not to associate a private hosted zone with the specified VPC. Applicable for endpoints of type Interface. Most users will want this enabled to allow services within the VPC to automatically use the endpoint. Defaults to false. If vpcEndpointType is anything other than Interface, changing this value forces a new resource to be created.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
resourceConfigurationArn → Input<String?>?
The ARN of a Resource Configuration to connect this VPC Endpoint to. Exactly one of resourceConfigurationArn, serviceName or serviceNetworkArn is required.
final
routeTableIds → Input<List<String>?>?
One or more route table IDs. Applicable for endpoints of type Gateway.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupIds → Input<List<String>?>?
The ID of one or more security groups to associate with the network interface. Applicable for endpoints of type Interface. If no security groups are specified, the VPC's default security group is associated with the endpoint.
final
serviceName → Input<String?>?
The service name. For AWS services the service name is usually in the form com.amazonaws.&lt;region&gt;.&lt;service&gt; (the SageMaker AI Notebook service is an exception to this rule, the service name is in the form aws.sagemaker.&lt;region&gt;.notebook). Exactly one of resourceConfigurationArn, serviceName or serviceNetworkArn is required.
final
serviceNetworkArn → Input<String?>?
The ARN of a Service Network to connect this VPC Endpoint to. Exactly one of resourceConfigurationArn, serviceName or serviceNetworkArn is required.
final
serviceRegion → Input<String?>?
The AWS region of the VPC Endpoint Service. If specified, the VPC endpoint will connect to the service in the provided region. Applicable for endpoints of type Interface.
final
subnetConfigurations → Input<List<VpcEndpointSubnetConfiguration>?>?
Subnet configuration for the endpoint, used to select specific IPv4 and/or IPv6 addresses to the endpoint. See subnetConfiguration below.
final
subnetIds → Input<List<String>?>?
The ID of one or more subnets in which to create a network interface for the endpoint. Applicable for endpoints of type GatewayLoadBalancer and Interface. Interface type endpoints cannot function without being assigned to a subnet.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
vpcEndpointType → Input<String?>?
The VPC endpoint type, Gateway, GatewayLoadBalancer,Interface, Resource or ServiceNetwork. Defaults to Gateway.
final
vpcId → Input<String>
The ID of the VPC in which the endpoint will be used.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited