Interface IEndpointPolicyConfig

NetworkConfig / EndpointPolicyConfig

Virtual Private Cloud (VPC) endpoint policy configuration.

Description

Use this configuration to define VPC endpoint policies for your VPC gateway and interface endpoints. The endpoint policy is a JSON policy document that controls which AWS principals can use the VPC endpoint to access the endpoint service.

The following example defines an endpoint policy named Default and references a path where a JSON policy document is stored:

Example

endpointPolicies:
  - name: Default
    document: path/to/document.json
interface IEndpointPolicyConfig {
    document: string;
    name: string;
}

Properties

document name

Properties

Readonlydocument

document: string

A file path for a JSON-formatted policy document.

Remarks

The referenced file path must exist in your accelerator configuration repository. The document must be valid JSON syntax.

Readonlyname

name: string

A friendly name for the endpoint policy.

Remarks

You use this logical name property as a reference to apply this policy to VPC gateway and interface endpoint configurations.

See

GatewayEndpointConfig | InterfaceEndpointConfig

Settings

Member Visibility

On This Page

Properties