VPCEndpointServiceConfiguration
ec2.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | ec2-controller/apis/v1alpha1#VPCEndpointServiceConfiguration |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | VPCEndpointServiceConfiguration |
| ListKind | VPCEndpointServiceConfigurationList |
| Plural | vpcendpointserviceconfigurations |
| Singular | vpcendpointserviceconfiguration |
Spec
acceptanceRequired: boolean
allowedPrincipals:
- string
gatewayLoadBalancerARNs:
- string
gatewayLoadBalancerRefs:
from:
name: string
namespace: string
networkLoadBalancerARNs:
- string
networkLoadBalancerRefs:
from:
name: string
namespace: string
privateDNSName: string
supportedIPAddressTypes:
- string
supportedRegions:
- string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| acceptanceRequired Optional | boolean Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually. |
| allowedPrincipals Optional | array The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*). |
| allowedPrincipals.[] Required | string |
| gatewayLoadBalancerARNs.[] Required | string |
| gatewayLoadBalancerRefs.[] Required | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference |
| type to provide more user friendly syntax for references using ‘from’ field | |
| Ex: | |
| APIIDRef: |
from:
name: my-api || **gatewayLoadBalancerRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| gatewayLoadBalancerRefs.[].from.name
Optional | string
|
| gatewayLoadBalancerRefs.[].from.namespace
Optional | string
|
| networkLoadBalancerARNs
Optional | array
The Amazon Resource Names (ARNs) of the Network Load Balancers. |
| networkLoadBalancerARNs.[]
Required | string
|| networkLoadBalancerRefs
Optional | array
|
| networkLoadBalancerRefs.[]
Required | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:
from:
name: my-api || **networkLoadBalancerRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| networkLoadBalancerRefs.[].from.name
Optional | string
|
| networkLoadBalancerRefs.[].from.namespace
Optional | string
|
| privateDNSName
Optional | string
(Interface endpoint configuration) The private DNS name to assign to the
VPC endpoint service. |
| supportedIPAddressTypes
Optional | array
The supported IP address types. The possible values are ipv4 and ipv6. |
| supportedIPAddressTypes.[]
Required | string
|| supportedRegions
Optional | array
The Regions from which service consumers can access the service. |
| supportedRegions.[]
Required | string
|| tags
Optional | array
The tags. The value parameter is required, but if you don’t want the tag
to have a value, specify the parameter with no value, and we set the value
to an empty string. |
| tags.[]
Required | object
Describes a tag. || tags.[].key
Optional | string
|
| tags.[].value
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
availabilityZones:
- string
baseEndpointDNSNames:
- string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
managesVPCEndpoints: boolean
payerResponsibility: string
privateDNSNameConfiguration:
name: string
state: string
type_: string
value: string
serviceID: string
serviceName: string
serviceState: string
serviceType:
- serviceType: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| availabilityZones Optional | array The Availability Zones in which the service is available. Either AvailabilityZone or AvailabilityZoneId can be specified, but not both |
| availabilityZones.[] Required | string |
| baseEndpointDNSNames.[] Required | string |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| managesVPCEndpoints Optional | boolean Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. |
| payerResponsibility Optional | string The payer responsibility. |
| privateDNSNameConfiguration Optional | object Information about the endpoint service private DNS name configuration. |
| privateDNSNameConfiguration.name Optional | string |
| privateDNSNameConfiguration.state Optional | string |
| **privateDNSNameConfiguration.type_** Optional | string |
| privateDNSNameConfiguration.value Optional | string |
| serviceID Optional | string The ID of the service. |
| serviceName Optional | string The name of the service. |
| serviceState Optional | string The service state. |
| serviceType Optional | array The type of service. |
| serviceType.[] Required | object Describes the type of service for a VPC endpoint. |