Interface IInterfaceEndpointServiceConfig

NetworkConfig / VpcConfig | VpcTemplatesConfig / InterfaceEndpointConfig / InterfaceEndpointServiceConfig

VPC interface endpoint service configuration.

Description

Use this configuration to define the service and endpoint policy for gateway endpoints.

Example

- service: ec2
  policy: Default
interface IInterfaceEndpointServiceConfig {
    applyPolicy?: boolean;
    policy?: string;
    securityGroup?: string;
    service: string;
    serviceName?: string;
}

Properties

applyPolicy? policy? securityGroup? service serviceName?

Properties

Optional ReadonlyapplyPolicy

applyPolicy?: boolean

(OPTIONAL) Specify whether or not a policy is applied to the endpoint. By default, if no policy is specified in the policy property, a default policy is applied. Specifying this option as false will ensure no policy is applied to the endpoint. This property defaults to true if not specified.

Optional Readonlypolicy

policy?: string

(OPTIONAL) The friendly name of a policy for the interface endpoint. If left undefined, the default policy will be used.

Remarks

This is the logical name property of the endpoint policy as defined in network-config.yaml.

See

EndpointPolicyConfig

Optional ReadonlysecurityGroup

securityGroup?: string

(OPTIONAL) Apply the provided security group for this interface endpoint.

Readonlyservice

service: string

The name of the service to create the endpoint for.

Remarks

The solution team does not keep a record of all possible interface endpoints that can be deployed. A full list of services that support interface endpoints can be found in the following documentation: https://docs.aws.amazon.com/vpc/latest/privatelink/aws-services-privatelink-support.html.

NOTE: The service name to input in this property is the suffix value after com.amazonaws.<REGION> noted in the above reference. Availability of interface endpoints as well as features such as endpoint policies may differ depending on region. Please use the instructions provided in the above reference to determine endpoint features and regional availability before deployment.

Optional ReadonlyserviceName

serviceName?: string

(OPTIONAL) The full name of the service to create the endpoint for.

Remarks

This property can be used to input the full endpoint service names that do not conform with the standard com.amazonaws.<REGION>.<SERVICE> syntax.

Settings

Member Visibility

On This Page

Properties