Interface IGatewayEndpointServiceConfig

NetworkConfig / VpcConfig | VpcTemplatesConfig / GatewayEndpointConfig / GatewayEndpointServiceConfig

VPC gateway endpoint service configuration.

Description

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

Example

- service: s3
  policy: Default
interface IGatewayEndpointServiceConfig {
    applyPolicy?: boolean;
    policy?: string;
    service: GatewayEndpointType;
    serviceName?: string;
}

Properties

applyPolicy? policy? 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 gateway 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

Readonlyservice

service: GatewayEndpointType

The name of the service to create the endpoint for

See

NetworkConfigTypes.gatewayEndpointEnum

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