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< ? routeTableIds, Input<String> ?>List< ? securityGroupIds, Input<String> ?>String?> ? serviceName, Input<String?> ? serviceNetworkArn, Input<String?> ? serviceRegion, Input<List< ? subnetConfigurations, Input<VpcEndpointSubnetConfiguration> ?>List< ? subnetIds, Input<String> ?>Map< ? tags, Input<String, String> ?>String?> ? vpcEndpointType, required Input<String> vpcId}) -
Creates a new VpcEndpointArgs.
autoAcceptAccept the VPC endpoint (the VPC endpoint and service need to be in the same AWS account).dnsOptionsThe DNS options for the endpoint. See dnsOptions below.ipAddressTypeThe IP address type for the endpoint. Valid values areipv4,dualstack, andipv6.policyA policy to attach to the endpoint that controls access to the service. This is a JSON formatted string. Defaults to full access. AllGatewayand someInterfaceendpoints support policies - see the relevant AWS documentation for more details.privateDnsEnabledWhether or not to associate a private hosted zone with the specified VPC. Applicable for endpoints of typeInterface. Most users will want this enabled to allow services within the VPC to automatically use the endpoint.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.resourceConfigurationArnThe ARN of a Resource Configuration to connect this VPC Endpoint to. Exactly one ofresourceConfigurationArn,serviceNameorserviceNetworkArnis required.routeTableIdsOne or more route table IDs. Applicable for endpoints of typeGateway.securityGroupIdsThe ID of one or more security groups to associate with the network interface. Applicable for endpoints of typeInterface.serviceNameThe service name. For AWS services the service name is usually in the formcom.amazonaws.<region>.<service>(the SageMaker AI Notebook service is an exception to this rule, the service name is in the formaws.sagemaker.<region>.notebook). Exactly one ofresourceConfigurationArn,serviceNameorserviceNetworkArnis required.serviceNetworkArnThe ARN of a Service Network to connect this VPC Endpoint to. Exactly one ofresourceConfigurationArn,serviceNameorserviceNetworkArnis required.serviceRegionThe 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 typeInterface.subnetConfigurationsSubnet configuration for the endpoint, used to select specific IPv4 and/or IPv6 addresses to the endpoint. See subnetConfiguration below.subnetIdsThe ID of one or more subnets in which to create a network interface for the endpoint. Applicable for endpoints of typeGatewayLoadBalancerandInterface. Interface type endpoints cannot function without being assigned to a subnet.tagsA map of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.vpcEndpointTypeThe VPC endpoint type,Gateway,GatewayLoadBalancer,Interface,ResourceorServiceNetwork. Defaults toGateway.vpcIdThe 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, andipv6.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
Gatewayand someInterfaceendpoints 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 tofalse. IfvpcEndpointTypeis anything other thanInterface, 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,serviceNameorserviceNetworkArnis 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.<region>.<service>(the SageMaker AI Notebook service is an exception to this rule, the service name is in the formaws.sagemaker.<region>.notebook). Exactly one ofresourceConfigurationArn,serviceNameorserviceNetworkArnis required.final -
serviceNetworkArn
→ Input<
String?> ? -
The ARN of a Service Network to connect this VPC Endpoint to. Exactly one of
resourceConfigurationArn,serviceNameorserviceNetworkArnis 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
GatewayLoadBalancerandInterface. Interface type endpoints cannot function without being assigned to a subnet.final -
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration 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,ResourceorServiceNetwork. Defaults toGateway.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