# API Reference ## Constructs ### AlbTargetGroup #### Initializers ```typescript import { AlbTargetGroup } from 'cdk-vpclattice-alpha' new AlbTargetGroup(scope: Construct, id: string, props: AlbTargetGroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AlbTargetGroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* AlbTargetGroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { AlbTargetGroup } from 'cdk-vpclattice-alpha' AlbTargetGroup.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { AlbTargetGroup } from 'cdk-vpclattice-alpha' AlbTargetGroup.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { AlbTargetGroup } from 'cdk-vpclattice-alpha' AlbTargetGroup.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | name | string | The name of the target group. | | targetGroupArn | string | The ARN of the target group. | | targetGroupId | string | The ID of the target group. | | targetType | TargetType | The type of target group. | | listenerPort | number | *No description.* | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer | *No description.* | | port | number | *No description.* | | protocol | RequestProtocol | *No description.* | | protocolVersion | RequestProtocolVersion | *No description.* | | vpc | aws-cdk-lib.aws_ec2.IVpc | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the target group. --- ##### `targetGroupArn`^Required ```typescript public readonly targetGroupArn: string; ``` - *Type:* string The ARN of the target group. --- ##### `targetGroupId`^Required ```typescript public readonly targetGroupId: string; ``` - *Type:* string The ID of the target group. --- ##### `targetType`^Required ```typescript public readonly targetType: TargetType; ``` - *Type:* TargetType The type of target group. --- ##### `listenerPort`^Required ```typescript public readonly listenerPort: number; ``` - *Type:* number --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number --- ##### `protocol`^Required ```typescript public readonly protocol: RequestProtocol; ``` - *Type:* RequestProtocol --- ##### `protocolVersion`^Required ```typescript public readonly protocolVersion: RequestProtocolVersion; ``` - *Type:* RequestProtocolVersion --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc --- ### InstanceTargetGroup Supports creating a Target group with instances within a specific VPC. #### Initializers ```typescript import { InstanceTargetGroup } from 'cdk-vpclattice-alpha' new InstanceTargetGroup(scope: Construct, id: string, props: InstanceTargetGroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | InstanceTargetGroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* InstanceTargetGroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addTarget | Adds a target to the target Group. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addTarget` ```typescript public addTarget(target: InstanceTarget): void ``` Adds a target to the target Group. ###### `target`^Required - *Type:* InstanceTarget --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { InstanceTargetGroup } from 'cdk-vpclattice-alpha' InstanceTargetGroup.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { InstanceTargetGroup } from 'cdk-vpclattice-alpha' InstanceTargetGroup.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { InstanceTargetGroup } from 'cdk-vpclattice-alpha' InstanceTargetGroup.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | name | string | The name of the target group. | | targetGroupArn | string | The ARN of the target group. | | targetGroupId | string | The ID of the target group. | | targetType | TargetType | The type of target group. | | autoScalingGroups | aws-cdk-lib.aws_autoscaling.IAutoScalingGroup[] | *No description.* | | healthCheck | HealthCheck | *No description.* | | instances | InstanceTarget[] | *No description.* | | port | number | *No description.* | | protocol | RequestProtocol | *No description.* | | vpc | aws-cdk-lib.aws_ec2.IVpc | *No description.* | | protocolVersion | RequestProtocolVersion | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the target group. --- ##### `targetGroupArn`^Required ```typescript public readonly targetGroupArn: string; ``` - *Type:* string The ARN of the target group. --- ##### `targetGroupId`^Required ```typescript public readonly targetGroupId: string; ``` - *Type:* string The ID of the target group. --- ##### `targetType`^Required ```typescript public readonly targetType: TargetType; ``` - *Type:* TargetType The type of target group. --- ##### `autoScalingGroups`^Required ```typescript public readonly autoScalingGroups: IAutoScalingGroup[]; ``` - *Type:* aws-cdk-lib.aws_autoscaling.IAutoScalingGroup[] --- ##### `healthCheck`^Required ```typescript public readonly healthCheck: HealthCheck; ``` - *Type:* HealthCheck --- ##### `instances`^Required ```typescript public readonly instances: InstanceTarget[]; ``` - *Type:* InstanceTarget[] --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number --- ##### `protocol`^Required ```typescript public readonly protocol: RequestProtocol; ``` - *Type:* RequestProtocol --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc --- ##### `protocolVersion`^Optional ```typescript public readonly protocolVersion: RequestProtocolVersion; ``` - *Type:* RequestProtocolVersion --- ### IpTargetGroup #### Initializers ```typescript import { IpTargetGroup } from 'cdk-vpclattice-alpha' new IpTargetGroup(scope: Construct, id: string, props: IpTargetGroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | IpTargetGroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* IpTargetGroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addTarget | Adds a target to the target Group. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addTarget` ```typescript public addTarget(target: IpTargetGroupTargetProps): void ``` Adds a target to the target Group. ###### `target`^Required - *Type:* IpTargetGroupTargetProps --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { IpTargetGroup } from 'cdk-vpclattice-alpha' IpTargetGroup.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { IpTargetGroup } from 'cdk-vpclattice-alpha' IpTargetGroup.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { IpTargetGroup } from 'cdk-vpclattice-alpha' IpTargetGroup.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | name | string | The name of the target group. | | targetGroupArn | string | The ARN of the target group. | | targetGroupId | string | The ID of the target group. | | targetType | TargetType | The type of target group. | | ipAddressType | IpAddressType | *No description.* | | port | number | *No description.* | | protocol | RequestProtocol | *No description.* | | targets | IpTargetGroupTargetProps[] | *No description.* | | vpc | aws-cdk-lib.aws_ec2.IVpc | *No description.* | | protocolVersion | RequestProtocolVersion | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the target group. --- ##### `targetGroupArn`^Required ```typescript public readonly targetGroupArn: string; ``` - *Type:* string The ARN of the target group. --- ##### `targetGroupId`^Required ```typescript public readonly targetGroupId: string; ``` - *Type:* string The ID of the target group. --- ##### `targetType`^Required ```typescript public readonly targetType: TargetType; ``` - *Type:* TargetType The type of target group. --- ##### `ipAddressType`^Required ```typescript public readonly ipAddressType: IpAddressType; ``` - *Type:* IpAddressType --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number --- ##### `protocol`^Required ```typescript public readonly protocol: RequestProtocol; ``` - *Type:* RequestProtocol --- ##### `targets`^Required ```typescript public readonly targets: IpTargetGroupTargetProps[]; ``` - *Type:* IpTargetGroupTargetProps[] --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc --- ##### `protocolVersion`^Optional ```typescript public readonly protocolVersion: RequestProtocolVersion; ``` - *Type:* RequestProtocolVersion --- ### LambdaTargetGroup #### Initializers ```typescript import { LambdaTargetGroup } from 'cdk-vpclattice-alpha' new LambdaTargetGroup(scope: Construct, id: string, props: LambdaTargetGroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | LambdaTargetGroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* LambdaTargetGroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { LambdaTargetGroup } from 'cdk-vpclattice-alpha' LambdaTargetGroup.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { LambdaTargetGroup } from 'cdk-vpclattice-alpha' LambdaTargetGroup.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { LambdaTargetGroup } from 'cdk-vpclattice-alpha' LambdaTargetGroup.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | name | string | The name of the target group. | | targetGroupArn | string | The ARN of the target group. | | targetGroupId | string | The ID of the target group. | | targetType | TargetType | The type of target group. | | lambdaEventStructureVersion | LambdaEventStructureVersion | *No description.* | | target | aws-cdk-lib.aws_lambda.Function | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the target group. --- ##### `targetGroupArn`^Required ```typescript public readonly targetGroupArn: string; ``` - *Type:* string The ARN of the target group. --- ##### `targetGroupId`^Required ```typescript public readonly targetGroupId: string; ``` - *Type:* string The ID of the target group. --- ##### `targetType`^Required ```typescript public readonly targetType: TargetType; ``` - *Type:* TargetType The type of target group. --- ##### `lambdaEventStructureVersion`^Required ```typescript public readonly lambdaEventStructureVersion: LambdaEventStructureVersion; ``` - *Type:* LambdaEventStructureVersion --- ##### `target`^Required ```typescript public readonly target: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function --- ### Listener - *Implements:* IListener A listener is a process that checks for connection requests, using the protocol and port that you configure. The rules that you define for a listener determine how the service routes requests to its registered targets. **This class should not be called directly**. Use the `.addListener()` method on an instance of a Service construct. #### Initializers ```typescript import { Listener } from 'cdk-vpclattice-alpha' new Listener(scope: Construct, id: string, props: ListenerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ListenerProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ListenerProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addRule | Adds a rule to the listener. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addRule` ```typescript public addRule(rule: AddRuleProps): void ``` Adds a rule to the listener. ###### `rule`^Required - *Type:* AddRuleProps --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { Listener } from 'cdk-vpclattice-alpha' Listener.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { Listener } from 'cdk-vpclattice-alpha' Listener.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Listener } from 'cdk-vpclattice-alpha' Listener.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | defaultAction | IRuleAction | The default action for this listener. | | listenerArn | string | The Amazon Resource Name (ARN) of the service. | | listenerId | string | The Id of the Service Network. | | port | number | The listener port. | | protocol | ListenerProtocol | The listener protocol. | | service | Service | The service this listener is attached to. | | name | string | The name of the listener. | | rules | AddRuleProps[] | The listener rules to add. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `defaultAction`^Required ```typescript public readonly defaultAction: IRuleAction; ``` - *Type:* IRuleAction The default action for this listener. --- ##### `listenerArn`^Required ```typescript public readonly listenerArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the service. --- ##### `listenerId`^Required ```typescript public readonly listenerId: string; ``` - *Type:* string The Id of the Service Network. --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number The listener port. --- ##### `protocol`^Required ```typescript public readonly protocol: ListenerProtocol; ``` - *Type:* ListenerProtocol The listener protocol. --- ##### `service`^Required ```typescript public readonly service: Service; ``` - *Type:* Service The service this listener is attached to. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of the listener. --- ##### `rules`^Required ```typescript public readonly rules: AddRuleProps[]; ``` - *Type:* AddRuleProps[] The listener rules to add. --- ### Service - *Implements:* IService Define a VPC Lattice Service. #### Initializers ```typescript import { Service } from 'cdk-vpclattice-alpha' new Service(scope: Construct, id: string, props: ServiceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ServiceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ServiceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addListener | Add Listener. | | associateWithServiceNetwork | Associate a Lattice Service with a Service Network. | | grantAccess | .grantAccess on a lattice service, will permit the principals to access all of the service. Consider using more granular permissions at the rule level. | | shareResource | Amazon VPC Lattice integrates with AWS Resource Access Manager (AWS RAM) to enable resource sharing across AWS accounts or through AWS Organizations. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addListener` ```typescript public addListener(listener: AddListenerProps): Listener ``` Add Listener. ###### `listener`^Required - *Type:* AddListenerProps --- ##### `associateWithServiceNetwork` ```typescript public associateWithServiceNetwork(serviceNetwork: IServiceNetwork): void ``` Associate a Lattice Service with a Service Network. ###### `serviceNetwork`^Required - *Type:* IServiceNetwork --- ##### `grantAccess` ```typescript public grantAccess(principals: IPrincipal[]): void ``` .grantAccess on a lattice service, will permit the principals to access all of the service. Consider using more granular permissions at the rule level. ###### `principals`^Required - *Type:* aws-cdk-lib.aws_iam.IPrincipal[] a list of IAM principals to grant access. --- ##### `shareResource` ```typescript public shareResource(props: ShareServiceProps): void ``` Amazon VPC Lattice integrates with AWS Resource Access Manager (AWS RAM) to enable resource sharing across AWS accounts or through AWS Organizations. ###### `props`^Required - *Type:* ShareServiceProps --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromServiceArn | *No description.* | | fromServiceId | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { Service } from 'cdk-vpclattice-alpha' Service.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { Service } from 'cdk-vpclattice-alpha' Service.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Service } from 'cdk-vpclattice-alpha' Service.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromServiceArn` ```typescript import { Service } from 'cdk-vpclattice-alpha' Service.fromServiceArn(scope: Construct, id: string, serviceArn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `serviceArn`^Required - *Type:* string --- ##### `fromServiceId` ```typescript import { Service } from 'cdk-vpclattice-alpha' Service.fromServiceId(scope: Construct, id: string, serviceId: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `serviceId`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | authPolicy | AuthPolicyDocument | Auth policy to be added to the service. | | authType | AuthType | The auth type of the service. | | dnsEntry | LatticeDnsEntry | VPC Lattice DNS Entry. | | loggingDestinations | LoggingDestination[] | Logging destinations of the service. | | serviceArn | string | The Amazon Resource Name (ARN) of the service. | | serviceId | string | The Id of the service. | | serviceName | string | The name of the service. | | customDomain | CustomDomainProps | Custom Domain Name. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `authPolicy`^Required ```typescript public readonly authPolicy: AuthPolicyDocument; ``` - *Type:* AuthPolicyDocument Auth policy to be added to the service. --- ##### `authType`^Required ```typescript public readonly authType: AuthType; ``` - *Type:* AuthType The auth type of the service. --- ##### `dnsEntry`^Required ```typescript public readonly dnsEntry: LatticeDnsEntry; ``` - *Type:* LatticeDnsEntry VPC Lattice DNS Entry. --- ##### `loggingDestinations`^Required ```typescript public readonly loggingDestinations: LoggingDestination[]; ``` - *Type:* LoggingDestination[] Logging destinations of the service. --- ##### `serviceArn`^Required ```typescript public readonly serviceArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the service. --- ##### `serviceId`^Required ```typescript public readonly serviceId: string; ``` - *Type:* string The Id of the service. --- ##### `serviceName`^Required ```typescript public readonly serviceName: string; ``` - *Type:* string The name of the service. --- ##### `customDomain`^Optional ```typescript public readonly customDomain: CustomDomainProps; ``` - *Type:* CustomDomainProps Custom Domain Name. --- ### ServiceNetwork - *Implements:* IServiceNetwork Define a VPC Lattice Service Network. #### Initializers ```typescript import { ServiceNetwork } from 'cdk-vpclattice-alpha' new ServiceNetwork(scope: Construct, id: string, props: ServiceNetworkProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ServiceNetworkProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ServiceNetworkProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addLoggingDestination | Send logs to a destination. | | associateService | Associate a Lattice Service with a Service Network. | | associateVPC | Apply the VPC to the Service Network. | | grantAccess | .grantAccess on a lattice service, will permit the principals to access all of the service. Consider using more granular permissions at the rule level. | | shareResource | Amazon VPC Lattice integrates with AWS Resource Access Manager (AWS RAM) to enable resource sharing across AWS accounts or through AWS Organizations. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addLoggingDestination` ```typescript public addLoggingDestination(destination: LoggingDestination): void ``` Send logs to a destination. ###### `destination`^Required - *Type:* LoggingDestination --- ##### `associateService` ```typescript public associateService(service: IService): void ``` Associate a Lattice Service with a Service Network. ###### `service`^Required - *Type:* IService --- ##### `associateVPC` ```typescript public associateVPC(props: AssociateVPCProps): void ``` Apply the VPC to the Service Network. ###### `props`^Required - *Type:* AssociateVPCProps --- ##### `grantAccess` ```typescript public grantAccess(principals: IPrincipal[]): void ``` .grantAccess on a lattice service, will permit the principals to access all of the service. Consider using more granular permissions at the rule level. ###### `principals`^Required - *Type:* aws-cdk-lib.aws_iam.IPrincipal[] a list of IAM principals to grant access. --- ##### `shareResource` ```typescript public shareResource(props: ShareServiceNetworkProps): void ``` Amazon VPC Lattice integrates with AWS Resource Access Manager (AWS RAM) to enable resource sharing across AWS accounts or through AWS Organizations. ###### `props`^Required - *Type:* ShareServiceNetworkProps --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromArn | Import a Service Network by Arn. | | fromId | Import a Service Network by Id. | --- ##### ~~`isConstruct`~~ ```typescript import { ServiceNetwork } from 'cdk-vpclattice-alpha' ServiceNetwork.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ServiceNetwork } from 'cdk-vpclattice-alpha' ServiceNetwork.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ServiceNetwork } from 'cdk-vpclattice-alpha' ServiceNetwork.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromArn` ```typescript import { ServiceNetwork } from 'cdk-vpclattice-alpha' ServiceNetwork.fromArn(scope: Construct, id: string, arn: string) ``` Import a Service Network by Arn. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `arn`^Required - *Type:* string --- ##### `fromId` ```typescript import { ServiceNetwork } from 'cdk-vpclattice-alpha' ServiceNetwork.fromId(scope: Construct, id: string, serviceNetworkId: string) ``` Import a Service Network by Id. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `serviceNetworkId`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | authPolicy | AuthPolicyDocument | Auth policy to be added to the service network. | | authType | AuthType | The auth type of the service network. | | loggingDestinations | LoggingDestination[] | Logging destinations of the service network. | | name | string | The name of the service network. | | serviceNetworkArn | string | The Amazon Resource Name (ARN) of the service network. | | serviceNetworkId | string | The Id of the Service Network. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `authPolicy`^Required ```typescript public readonly authPolicy: AuthPolicyDocument; ``` - *Type:* AuthPolicyDocument Auth policy to be added to the service network. --- ##### `authType`^Required ```typescript public readonly authType: AuthType; ``` - *Type:* AuthType - *Default:* AuthType.NONE The auth type of the service network. --- ##### `loggingDestinations`^Required ```typescript public readonly loggingDestinations: LoggingDestination[]; ``` - *Type:* LoggingDestination[] Logging destinations of the service network. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the service network. --- ##### `serviceNetworkArn`^Required ```typescript public readonly serviceNetworkArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the service network. --- ##### `serviceNetworkId`^Required ```typescript public readonly serviceNetworkId: string; ``` - *Type:* string The Id of the Service Network. --- ### ServiceNetworkServiceAssociation Creates an Association Between a Lattice Service and a Service Network. Consider using `.associateService` of the ServiceNetwork construct or `.associateWithServiceNetwork` of the Service construct #### Initializers ```typescript import { ServiceNetworkServiceAssociation } from 'cdk-vpclattice-alpha' new ServiceNetworkServiceAssociation(scope: Construct, id: string, props: ServiceNetworkAssociationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ServiceNetworkAssociationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ServiceNetworkAssociationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { ServiceNetworkServiceAssociation } from 'cdk-vpclattice-alpha' ServiceNetworkServiceAssociation.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ServiceNetworkServiceAssociation } from 'cdk-vpclattice-alpha' ServiceNetworkServiceAssociation.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ServiceNetworkServiceAssociation } from 'cdk-vpclattice-alpha' ServiceNetworkServiceAssociation.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ### ServiceNetworkVpcAssociation Associate a VPC with Lattice Service Network. #### Initializers ```typescript import { ServiceNetworkVpcAssociation } from 'cdk-vpclattice-alpha' new ServiceNetworkVpcAssociation(scope: Construct, id: string, props: ServiceNetworkVpcAssociationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ServiceNetworkVpcAssociationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ServiceNetworkVpcAssociationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { ServiceNetworkVpcAssociation } from 'cdk-vpclattice-alpha' ServiceNetworkVpcAssociation.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ServiceNetworkVpcAssociation } from 'cdk-vpclattice-alpha' ServiceNetworkVpcAssociation.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ServiceNetworkVpcAssociation } from 'cdk-vpclattice-alpha' ServiceNetworkVpcAssociation.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ### TargetGroupBase - *Implements:* ITargetGroup Properties for a Target Group, Only supply one of instanceTargets, lambdaTargets, albTargets, ipTargets. #### Initializers ```typescript import { TargetGroupBase } from 'cdk-vpclattice-alpha' new TargetGroupBase(scope: Construct, id: string, props?: ResourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.ResourceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* aws-cdk-lib.ResourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { TargetGroupBase } from 'cdk-vpclattice-alpha' TargetGroupBase.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { TargetGroupBase } from 'cdk-vpclattice-alpha' TargetGroupBase.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { TargetGroupBase } from 'cdk-vpclattice-alpha' TargetGroupBase.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | name | string | The name of the target group. | | targetGroupArn | string | The ARN of the target group. | | targetGroupId | string | The ID of the target group. | | targetType | TargetType | The type of target group. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the target group. --- ##### `targetGroupArn`^Required ```typescript public readonly targetGroupArn: string; ``` - *Type:* string The ARN of the target group. --- ##### `targetGroupId`^Required ```typescript public readonly targetGroupId: string; ``` - *Type:* string The ID of the target group. --- *Example* ```typescript "tg-1332423" ``` ##### `targetType`^Required ```typescript public readonly targetType: TargetType; ``` - *Type:* TargetType The type of target group. --- ## Structs ### AddListenerProps #### Initializer ```typescript import { AddListenerProps } from 'cdk-vpclattice-alpha' const addListenerProps: AddListenerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultAction | RuleAction | * A default action that will be taken if no rules match. | | name | string | The Name of the listener. | | port | number | Optional port number for the listener. | | protocol | ListenerProtocol | Protocol that the listener will listen on. | | removalPolicy | aws-cdk-lib.RemovalPolicy | Determine what happens to the service when the resource/stack is deleted. | | rules | AddRuleProps[] | Rules to add to the listener. | --- ##### `defaultAction`^Optional ```typescript public readonly defaultAction: RuleAction; ``` - *Type:* RuleAction - *Default:* HTTPFixedResponse.NOT_FOUND * A default action that will be taken if no rules match. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The Name of the listener. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* 80 or 443 depending on the Protocol Optional port number for the listener. If not supplied, will default to 80 or 443, depending on the Protocol. --- ##### `protocol`^Optional ```typescript public readonly protocol: ListenerProtocol; ``` - *Type:* ListenerProtocol Protocol that the listener will listen on. --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.RETAIN Determine what happens to the service when the resource/stack is deleted. --- ##### `rules`^Optional ```typescript public readonly rules: AddRuleProps[]; ``` - *Type:* AddRuleProps[] Rules to add to the listener. --- ### AddRuleProps #### Initializer ```typescript import { AddRuleProps } from 'cdk-vpclattice-alpha' const addRuleProps: AddRuleProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | IRuleAction | the action for the rule, is either a fixed Response, or a being sent to Weighted TargetGroup. | | name | string | A name for the the Rule. | | priority | number | The priority of this rule, a lower priority will be processed first. | | matchHeader | IMatchHeader[] | The headers to match for the rule. | | matchMethod | HttpMethod | The method to match for the rule. | | matchPath | IMatchPath | The path to match for the rule. | --- ##### `action`^Required ```typescript public readonly action: IRuleAction; ``` - *Type:* IRuleAction the action for the rule, is either a fixed Response, or a being sent to Weighted TargetGroup. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string A name for the the Rule. --- ##### `priority`^Required ```typescript public readonly priority: number; ``` - *Type:* number The priority of this rule, a lower priority will be processed first. --- ##### `matchHeader`^Optional ```typescript public readonly matchHeader: IMatchHeader[]; ``` - *Type:* IMatchHeader[] The headers to match for the rule. --- ##### `matchMethod`^Optional ```typescript public readonly matchMethod: HttpMethod; ``` - *Type:* HttpMethod The method to match for the rule. --- ##### `matchPath`^Optional ```typescript public readonly matchPath: IMatchPath; ``` - *Type:* IMatchPath The path to match for the rule. --- ### AlbTargetGroupProps #### Initializer ```typescript import { AlbTargetGroupProps } from 'cdk-vpclattice-alpha' const albTargetGroupProps: AlbTargetGroupProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer | You can specify a single **internal** Application Load Balancer as the target. | | vpc | aws-cdk-lib.aws_ec2.IVpc | VPC. | | listenerPort | number | This port is used for routing traffic to the target, and defaults to the target group port. | | name | string | The name of the target group. | | port | number | The port on which the target group will listen. | | protocol | RequestProtocol | The protocol to use for routing traffic to the targets. | | protocolVersion | RequestProtocolVersion | Choose the protocol version for requests to be sent to targets. | --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer You can specify a single **internal** Application Load Balancer as the target. --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc VPC. --- ##### `listenerPort`^Optional ```typescript public readonly listenerPort: number; ``` - *Type:* number This port is used for routing traffic to the target, and defaults to the target group port. However, you can override the default and specify a custom port that matches the port of your Application Load Balancer's listeners --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of the target group. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* 443 The port on which the target group will listen. --- ##### `protocol`^Optional ```typescript public readonly protocol: RequestProtocol; ``` - *Type:* RequestProtocol - *Default:* Protocol.HTTPS The protocol to use for routing traffic to the targets. Can't be changed after creation. --- ##### `protocolVersion`^Optional ```typescript public readonly protocolVersion: RequestProtocolVersion; ``` - *Type:* RequestProtocolVersion - *Default:* Protocol.HTTP1 Choose the protocol version for requests to be sent to targets. The protocol version you choose must support the request protocols from clients. --- ### AssociateVPCProps Properties to associate a VPC with a Service Network. #### Initializer ```typescript import { AssociateVPCProps } from 'cdk-vpclattice-alpha' const associateVPCProps: AssociateVPCProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC to associate with the Service Network. | | securityGroups | aws-cdk-lib.aws_ec2.SecurityGroup[] | The security groups to associate with the Service Network. | --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC to associate with the Service Network. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: SecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.SecurityGroup[] - *Default:* a security group that allows inbound 443 will be permitted. The security groups to associate with the Service Network. --- ### BaseTargetGroupProps Basic properties for a Target Group. #### Initializer ```typescript import { BaseTargetGroupProps } from 'cdk-vpclattice-alpha' const baseTargetGroupProps: BaseTargetGroupProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | targetGroupName | string | The name of the target group. | | targetType | TargetType | The type of targets registered to this TargetGroup, either IP or Instance. | --- ##### `targetGroupName`^Optional ```typescript public readonly targetGroupName: string; ``` - *Type:* string - *Default:* Automatically generated. The name of the target group. Must be between 3-128 characters. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. --- ##### `targetType`^Optional ```typescript public readonly targetType: TargetType; ``` - *Type:* TargetType - *Default:* Determined automatically. The type of targets registered to this TargetGroup, either IP or Instance. All targets registered into the group must be of this type. If you register targets to the TargetGroup in the CDK app, the TargetType is determined automatically. --- ### CustomDomainProps #### Initializer ```typescript import { CustomDomainProps } from 'cdk-vpclattice-alpha' const customDomainProps: CustomDomainProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domainName | string | A registered custom domain name for your service. | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | A certificate that may be used by the service. | | hostedZone | aws-cdk-lib.aws_route53.IHostedZone | The Route53 Private Hosted Zone or Public Hosted Zone. | | recordType | MappingRecordType | The type of record to be added to the hosted zone. | --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string - *Default:* Your service will be reachable only by the domain name that VPC Lattice generates A registered custom domain name for your service. Requests to the custom domain are resolved by the DNS server to the VPC Lattice generated domain name. Note: **Changing it requires recreating the service.** > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-custom-domain-name.html](https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-custom-domain-name.html) --- ##### `certificate`^Optional ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate - *Default:* No custom certificate is used. A certificate that may be used by the service. To receive HTTPS requests, you must provide your own certificate in AWS Certificate Manager. > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-byoc.html](https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-byoc.html) --- ##### `hostedZone`^Optional ```typescript public readonly hostedZone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone The Route53 Private Hosted Zone or Public Hosted Zone. This will add a record between the custom domain name and the VPC Lattice service generated DNS name. Leave empty if DNS is managed outside of Route53 or if you want to manually add the Route53 Alias or CNAME record. --- ##### `recordType`^Optional ```typescript public readonly recordType: MappingRecordType; ``` - *Type:* MappingRecordType - *Default:* MappingRecordType.ALIAS The type of record to be added to the hosted zone. Available options are: Alias (default), or CNAME > [https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-choosing-alias-non-alias.html](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-choosing-alias-non-alias.html) --- ### HealthCheck Create a Health Check for a target. > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-group-health-checks.html](https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-group-health-checks.html) #### Initializer ```typescript import { HealthCheck } from 'cdk-vpclattice-alpha' const healthCheck: HealthCheck = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | Whether to enable health checks for the target group. | | healthCheckInterval | aws-cdk-lib.Duration | The approximate amount of time, in seconds, between health checks of an individual target. | | healthCheckTimeout | aws-cdk-lib.Duration | The amount of time, in seconds, during which no response from a target means a failed health check. | | healthyThresholdCount | number | The number of consecutive successful health checks required before an unhealthy target is considered healthy. | | matchers | string \| HttpFixedResponse | The codes to use when checking for a successful response from a target. | | path | string | The ping path to the destination on the targets for health checks. | | port | number | The port the service uses when performing health checks on targets. | | protocol | HealthCheckProtocol | The protocol the service uses when performing health checks on targets. | | protocolVersion | HealthCheckProtocolVersion | Protocol Version to use for Health Check. | | unhealthyThresholdCount | number | The number of consecutive health check failures required before considering a target unhealthy. | --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean - *Default:* true if protocol version is HTTP1, false if protocol version is HTTP2, Whether to enable health checks for the target group. --- ##### `healthCheckInterval`^Optional ```typescript public readonly healthCheckInterval: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.seconds(30) The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. --- ##### `healthCheckTimeout`^Optional ```typescript public readonly healthCheckTimeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.seconds(5) The amount of time, in seconds, during which no response from a target means a failed health check. The range is 1–120 seconds. --- ##### `healthyThresholdCount`^Optional ```typescript public readonly healthyThresholdCount: number; ``` - *Type:* number - *Default:* 5 The number of consecutive successful health checks required before an unhealthy target is considered healthy. The range is 2–10. --- ##### `matchers`^Optional ```typescript public readonly matchers: string | HttpFixedResponse; ``` - *Type:* string | HttpFixedResponse - *Default:* FixedResponse.OK The codes to use when checking for a successful response from a target. These are called Success codes in the AWS Console. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299"). --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string - *Default:* '/' (ping to the root domain) The ping path to the destination on the targets for health checks. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* Defaults to port 80 for HTTP, or 443 for HTTPS The port the service uses when performing health checks on targets. --- ##### `protocol`^Optional ```typescript public readonly protocol: HealthCheckProtocol; ``` - *Type:* HealthCheckProtocol - *Default:* HealthCheckProtocol.HTTP The protocol the service uses when performing health checks on targets. Health checks do not support gRPC target group protocol versions. --- ##### `protocolVersion`^Optional ```typescript public readonly protocolVersion: HealthCheckProtocolVersion; ``` - *Type:* HealthCheckProtocolVersion - *Default:* HealthCheckProtocolVersion.HTTP1 Protocol Version to use for Health Check. --- ##### `unhealthyThresholdCount`^Optional ```typescript public readonly unhealthyThresholdCount: number; ``` - *Type:* number - *Default:* 2 The number of consecutive health check failures required before considering a target unhealthy. The range is 2–10. --- ### InstanceTarget #### Initializer ```typescript import { InstanceTarget } from 'cdk-vpclattice-alpha' const instanceTarget: InstanceTarget = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instance | aws-cdk-lib.aws_ec2.IInstance | The EC2 Instance. | | port | number | The port on which the target is listening. | --- ##### `instance`^Required ```typescript public readonly instance: IInstance; ``` - *Type:* aws-cdk-lib.aws_ec2.IInstance The EC2 Instance. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* Defaults to port 80 for HTTP, or 443 for HTTPS The port on which the target is listening. --- ### InstanceTargetGroupProps #### Initializer ```typescript import { InstanceTargetGroupProps } from 'cdk-vpclattice-alpha' const instanceTargetGroupProps: InstanceTargetGroupProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where the target instances reside. | | autoScalingGroups | aws-cdk-lib.aws_autoscaling.IAutoScalingGroup[] | The ASGs to associate with the target group. | | healthCheck | HealthCheck | Healthcheck. | | instances | InstanceTarget[] | The targets to associate with the target group. | | name | string | The name of the target group. | | port | number | *No description.* | | protocol | RequestProtocol | The protocol to use for routing traffic to the targets. | | protocolVersion | RequestProtocolVersion | Choose the protocol version for requests to be sent to targets. | --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC where the target instances reside. --- ##### `autoScalingGroups`^Optional ```typescript public readonly autoScalingGroups: IAutoScalingGroup[]; ``` - *Type:* aws-cdk-lib.aws_autoscaling.IAutoScalingGroup[] The ASGs to associate with the target group. --- ##### `healthCheck`^Optional ```typescript public readonly healthCheck: HealthCheck; ``` - *Type:* HealthCheck Healthcheck. --- ##### `instances`^Optional ```typescript public readonly instances: InstanceTarget[]; ``` - *Type:* InstanceTarget[] The targets to associate with the target group. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* Automatically generated name The name of the target group. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* Defaults to port 80 for HTTP, or 443 for HTTPS --- ##### `protocol`^Optional ```typescript public readonly protocol: RequestProtocol; ``` - *Type:* RequestProtocol - *Default:* Protocol.HTTPS The protocol to use for routing traffic to the targets. Can't be changed after creation. --- ##### `protocolVersion`^Optional ```typescript public readonly protocolVersion: RequestProtocolVersion; ``` - *Type:* RequestProtocolVersion - *Default:* Protocol.HTTP1 if HTTP or HTTPS is selected Choose the protocol version for requests to be sent to targets. The protocol version you choose must support the request protocols from clients. --- ### IpTargetGroupProps #### Initializer ```typescript import { IpTargetGroupProps } from 'cdk-vpclattice-alpha' const ipTargetGroupProps: IpTargetGroupProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | vpc | aws-cdk-lib.aws_ec2.IVpc | VPC Identifier. | | healthCheck | HealthCheck | Health Check configuration. | | ipAddressType | IpAddressType | The type of IP Address Protocol to use. | | name | string | The name of the target group. | | port | number | Port. | | protocol | RequestProtocol | The application layer protocol to use. | | protocolVersion | RequestProtocolVersion | ProtocolVersion. | | targets | IpTargetGroupTargetProps[] | Targets. | --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc VPC Identifier. --- ##### `healthCheck`^Optional ```typescript public readonly healthCheck: HealthCheck; ``` - *Type:* HealthCheck Health Check configuration. --- ##### `ipAddressType`^Optional ```typescript public readonly ipAddressType: IpAddressType; ``` - *Type:* IpAddressType - *Default:* IpAddressType.IPv4 The type of IP Address Protocol to use. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of the target group. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* Defaults to port 80 for HTTP, or 443 for HTTPS Port. --- ##### `protocol`^Optional ```typescript public readonly protocol: RequestProtocol; ``` - *Type:* RequestProtocol - *Default:* RequestProtocol.HTTPS The application layer protocol to use. --- ##### `protocolVersion`^Optional ```typescript public readonly protocolVersion: RequestProtocolVersion; ``` - *Type:* RequestProtocolVersion - *Default:* RequestProtocolVersion.HTTP1 ProtocolVersion. --- ##### `targets`^Optional ```typescript public readonly targets: IpTargetGroupTargetProps[]; ``` - *Type:* IpTargetGroupTargetProps[] Targets. --- ### IpTargetGroupTargetProps #### Initializer ```typescript import { IpTargetGroupTargetProps } from 'cdk-vpclattice-alpha' const ipTargetGroupTargetProps: IpTargetGroupTargetProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ipAddress | aws-cdk-lib.aws_ec2.Ipv6Addresses \| aws-cdk-lib.aws_ec2.IpAddresses | The IP Address of the target. | | port | number | Port. | --- ##### `ipAddress`^Required ```typescript public readonly ipAddress: Ipv6Addresses | IpAddresses; ``` - *Type:* aws-cdk-lib.aws_ec2.Ipv6Addresses | aws-cdk-lib.aws_ec2.IpAddresses The IP Address of the target. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* Defaults to port 80 for HTTP, or 443 for HTTPS Port. --- ### LambdaTargetGroupProps #### Initializer ```typescript import { LambdaTargetGroupProps } from 'cdk-vpclattice-alpha' const lambdaTargetGroupProps: LambdaTargetGroupProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | target | aws-cdk-lib.aws_lambda.Function | Facilitates routing to a **single** Lambda function. | | lambdaEventStructureVersion | LambdaEventStructureVersion | The version of the event structure that Lambda function receives. | | name | string | The name of the target group. | --- ##### `target`^Required ```typescript public readonly target: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function Facilitates routing to a **single** Lambda function. --- ##### `lambdaEventStructureVersion`^Optional ```typescript public readonly lambdaEventStructureVersion: LambdaEventStructureVersion; ``` - *Type:* LambdaEventStructureVersion - *Default:* LambdaEventStructureVersion.V1 The version of the event structure that Lambda function receives. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of the target group. --- ### LatticeDnsEntry #### Initializer ```typescript import { LatticeDnsEntry } from 'cdk-vpclattice-alpha' const latticeDnsEntry: LatticeDnsEntry = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domainName | string | The domain name of the service. | | hostedZone | aws-cdk-lib.aws_route53.IHostedZone | The Route53 Private Hosted Zone or Public Hosted Zone. | --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string The domain name of the service. --- ##### `hostedZone`^Required ```typescript public readonly hostedZone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone The Route53 Private Hosted Zone or Public Hosted Zone. --- ### ListenerProps Properties to Create a Lattice Listener. #### Initializer ```typescript import { ListenerProps } from 'cdk-vpclattice-alpha' const listenerProps: ListenerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | service | Service | The Id of the service that this listener is associated with. | | defaultAction | IRuleAction | * A default action that will be taken if no rules match. | | name | string | The Name of the listener. | | port | number | Optional port number for the listener. | | protocol | ListenerProtocol | Protocol that the listener will listen on. | | removalPolicy | aws-cdk-lib.RemovalPolicy | Determine what happens to the service when the resource/stack is deleted. | | rules | AddRuleProps[] | Rules to add to the listener. | --- ##### `service`^Required ```typescript public readonly service: Service; ``` - *Type:* Service The Id of the service that this listener is associated with. --- ##### `defaultAction`^Optional ```typescript public readonly defaultAction: IRuleAction; ``` - *Type:* IRuleAction - *Default:* HTTPFixedResponse.NOT_FOUND * A default action that will be taken if no rules match. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The Name of the listener. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number - *Default:* 80 or 443 depending on the Protocol Optional port number for the listener. If not supplied, will default to 80 or 443, depending on the Protocol. --- ##### `protocol`^Optional ```typescript public readonly protocol: ListenerProtocol; ``` - *Type:* ListenerProtocol Protocol that the listener will listen on. --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.RETAIN Determine what happens to the service when the resource/stack is deleted. --- ##### `rules`^Optional ```typescript public readonly rules: AddRuleProps[]; ``` - *Type:* AddRuleProps[] Rules to add to the listener. --- ### ServiceNetworkAssociationProps Properties for associating a VPC with a Service Network. #### Initializer ```typescript import { ServiceNetworkAssociationProps } from 'cdk-vpclattice-alpha' const serviceNetworkAssociationProps: ServiceNetworkAssociationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | service | IService | Lattice ServiceId. | | serviceNetwork | IServiceNetwork | lattice Service. | --- ##### `service`^Required ```typescript public readonly service: IService; ``` - *Type:* IService Lattice ServiceId. --- ##### `serviceNetwork`^Required ```typescript public readonly serviceNetwork: IServiceNetwork; ``` - *Type:* IServiceNetwork lattice Service. --- ### ServiceNetworkProps Properties for defining a VPC Lattice Service Network. #### Initializer ```typescript import { ServiceNetworkProps } from 'cdk-vpclattice-alpha' const serviceNetworkProps: ServiceNetworkProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authPolicy | AuthPolicyDocument | Policy to apply to the service network. | | authType | AuthType | The authentication and authorization that manages client access to the network. | | loggingDestinations | LoggingDestination[] | Where to send access logs. | | name | string | The name of the Service Network. | | removalPolicy | aws-cdk-lib.RemovalPolicy | Determine what happens to the repository when the resource/stack is deleted. | | services | IService[] | Lattice Services that are associated with this Service Network. | | vpcAssociations | AssociateVPCProps[] | You can associate VPCs to your service network at or after network creation. | --- ##### `authPolicy`^Optional ```typescript public readonly authPolicy: AuthPolicyDocument; ``` - *Type:* AuthPolicyDocument - *Default:* No policy is applied Policy to apply to the service network. --- ##### `authType`^Optional ```typescript public readonly authType: AuthType; ``` - *Type:* AuthType - *Default:* AuthType.NONE The authentication and authorization that manages client access to the network. If `AuthType.AWS_IAM` is selected, and a policy is not attached, all traffic will be denied by default regardless of the identity or service level permissions. --- ##### `loggingDestinations`^Optional ```typescript public readonly loggingDestinations: LoggingDestination[]; ``` - *Type:* LoggingDestination[] - *Default:* No logging Where to send access logs. Access log entries represent traffic originated from VPCs associated with that network. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* CloudFormation generated name The name of the Service Network. If not provided, CloudFormation will generate a name. --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.RETAIN Determine what happens to the repository when the resource/stack is deleted. --- ##### `services`^Optional ```typescript public readonly services: IService[]; ``` - *Type:* IService[] - *Default:* no services are associated with the service network Lattice Services that are associated with this Service Network. --- ##### `vpcAssociations`^Optional ```typescript public readonly vpcAssociations: AssociateVPCProps[]; ``` - *Type:* AssociateVPCProps[] - *Default:* no VPCs are associated You can associate VPCs to your service network at or after network creation. After association, services within the VPC can make calls to services in the service network. Any VPC owner with access to the service network can associate their VPCs to it. --- ### ServiceNetworkVpcAssociationProps Props to Associate a VPC with a Service Network. #### Initializer ```typescript import { ServiceNetworkVpcAssociationProps } from 'cdk-vpclattice-alpha' const serviceNetworkVpcAssociationProps: ServiceNetworkVpcAssociationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | serviceNetworkId | string | Service Network Identifier. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC to associate with. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | Security groups for the lattice endpoint. | --- ##### `serviceNetworkId`^Required ```typescript public readonly serviceNetworkId: string; ``` - *Type:* string Service Network Identifier. --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC to associate with. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] Security groups for the lattice endpoint. --- ### ServiceProps Properties for defining a VPC Lattice Service. #### Initializer ```typescript import { ServiceProps } from 'cdk-vpclattice-alpha' const serviceProps: ServiceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authPolicy | AuthPolicyDocument | Policy to apply to the service. | | authType | AuthType | The authentication and authorization that manages client access to the service. | | customDomain | CustomDomainProps | A registered custom domain name for your service. | | loggingDestinations | LoggingDestination[] | Where to send access logs. | | name | string | The name to assign to the service. | | removalPolicy | aws-cdk-lib.RemovalPolicy | Determine what happens to the service when the resource/stack is deleted. | | serviceNetwork | IServiceNetwork | ServiceNetwork to associate with. | --- ##### `authPolicy`^Optional ```typescript public readonly authPolicy: AuthPolicyDocument; ``` - *Type:* AuthPolicyDocument - *Default:* No policy is attached. All traffic is denied by default. Policy to apply to the service. --- ##### `authType`^Optional ```typescript public readonly authType: AuthType; ``` - *Type:* AuthType - *Default:* AuthType.NONE The authentication and authorization that manages client access to the service. If AuthType.AWS_IAM is selected, and an auth policy is not attached or an access mode is not specified, all traffic will be denied to the service, regardless of the identity or permissions associated with the service network-level policy. --- ##### `customDomain`^Optional ```typescript public readonly customDomain: CustomDomainProps; ``` - *Type:* CustomDomainProps - *Default:* Your service will be reachable only by the domain name that VPC Lattice generates A registered custom domain name for your service. Requests to the custom domain are resolved by the DNS server to the VPC Lattice generated domain name. Note: **Changing it requires recreating the service.** > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-custom-domain-name.html](https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-custom-domain-name.html) --- ##### `loggingDestinations`^Optional ```typescript public readonly loggingDestinations: LoggingDestination[]; ``` - *Type:* LoggingDestination[] - *Default:* No logging Where to send access logs. Access log entries represent traffic originated from VPCs associated with that network. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* a CloudFormation generated name The name to assign to the service. Note: It must be unique within your AWS account and this name will become part of the service DNS and can't be changed after the VPC Lattice service is created. > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html](https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html) --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.RETAIN Determine what happens to the service when the resource/stack is deleted. --- ##### `serviceNetwork`^Optional ```typescript public readonly serviceNetwork: IServiceNetwork; ``` - *Type:* IServiceNetwork - *Default:* will not associate with any serviceNetwork. ServiceNetwork to associate with. --- ### ShareServiceNetworkProps Properties to share a Service Network. > [https://docs.aws.amazon.com/ram/latest/userguide/shareable.html#shareable-vpc-lattice](https://docs.aws.amazon.com/ram/latest/userguide/shareable.html#shareable-vpc-lattice) #### Initializer ```typescript import { ShareServiceNetworkProps } from 'cdk-vpclattice-alpha' const shareServiceNetworkProps: ShareServiceNetworkProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of the share. | | allowExternalPrincipals | boolean | Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. | | principals | string[] | Principals to share the Service Network with. | | resourceArns | string[] | Resources to share the Service Network with. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the share. --- ##### `allowExternalPrincipals`^Optional ```typescript public readonly allowExternalPrincipals: boolean; ``` - *Type:* boolean - *Default:* true; Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are *not* in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. --- ##### `principals`^Optional ```typescript public readonly principals: string[]; ``` - *Type:* string[] - *Default:* none Principals to share the Service Network with. --- ##### `resourceArns`^Optional ```typescript public readonly resourceArns: string[]; ``` - *Type:* string[] - *Default:* none Resources to share the Service Network with. --- ### ShareServiceProps #### Initializer ```typescript import { ShareServiceProps } from 'cdk-vpclattice-alpha' const shareServiceProps: ShareServiceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of the share. | | allowExternalPrincipals | boolean | Whether external principals are allowed. | | principals | string[] | Principals to share the Service Network with. | | resourceArns | string[] | Resources to share the Service Network with. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the share. --- ##### `allowExternalPrincipals`^Optional ```typescript public readonly allowExternalPrincipals: boolean; ``` - *Type:* boolean - *Default:* false; Whether external principals are allowed. --- ##### `principals`^Optional ```typescript public readonly principals: string[]; ``` - *Type:* string[] - *Default:* none Principals to share the Service Network with. --- ##### `resourceArns`^Optional ```typescript public readonly resourceArns: string[]; ``` - *Type:* string[] - *Default:* none Resources to share the Service Network with. --- ### WeightedTargetGroup A Target Group and weight combination. #### Initializer ```typescript import { WeightedTargetGroup } from 'cdk-vpclattice-alpha' const weightedTargetGroup: WeightedTargetGroup = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | targetGroup | ITargetGroup | The target group. | | weight | number | The target group's weight. | --- ##### `targetGroup`^Required ```typescript public readonly targetGroup: ITargetGroup; ``` - *Type:* ITargetGroup The target group. --- ##### `weight`^Optional ```typescript public readonly weight: number; ``` - *Type:* number - *Default:* 1 The target group's weight. Range is [0..1000). --- ## Classes ### AuthPolicyDocument #### Initializers ```typescript import { AuthPolicyDocument } from 'cdk-vpclattice-alpha' new AuthPolicyDocument(props?: PolicyDocumentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | aws-cdk-lib.aws_iam.PolicyDocumentProps | *No description.* | --- ##### `props`^Optional - *Type:* aws-cdk-lib.aws_iam.PolicyDocumentProps --- #### Methods | **Name** | **Description** | | --- | --- | | addStatements | Adds a statement to the policy document. | | resolve | Produce the Token's value at resolution time. | | toJSON | JSON-ify the document. | | toString | Encode the policy document as a string. | | validateForAnyPolicy | Validate that all policy statements in the policy document satisfies the requirements for any policy. | | validateForIdentityPolicy | Validate that all policy statements in the policy document satisfies the requirements for an identity-based policy. | | validateForResourcePolicy | Validate that all policy statements in the policy document satisfies the requirements for a resource-based policy. | | validateAuthPolicy | Must ensure Service has the correct AuthType and policy is a valid IAM Resource-based Policy for VPC Lattice. | --- ##### `addStatements` ```typescript public addStatements(statement: PolicyStatement): void ``` Adds a statement to the policy document. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement the statement to add. --- ##### `resolve` ```typescript public resolve(context: IResolveContext): any ``` Produce the Token's value at resolution time. ###### `context`^Required - *Type:* aws-cdk-lib.IResolveContext --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON-ify the document. Used when JSON.stringify() is called ##### `toString` ```typescript public toString(): string ``` Encode the policy document as a string. ##### `validateForAnyPolicy` ```typescript public validateForAnyPolicy(): string[] ``` Validate that all policy statements in the policy document satisfies the requirements for any policy. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json) ##### `validateForIdentityPolicy` ```typescript public validateForIdentityPolicy(): string[] ``` Validate that all policy statements in the policy document satisfies the requirements for an identity-based policy. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json) ##### `validateForResourcePolicy` ```typescript public validateForResourcePolicy(): string[] ``` Validate that all policy statements in the policy document satisfies the requirements for a resource-based policy. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json) ##### `validateAuthPolicy` ```typescript public validateAuthPolicy(): string[] ``` Must ensure Service has the correct AuthType and policy is a valid IAM Resource-based Policy for VPC Lattice. #### Static Functions | **Name** | **Description** | | --- | --- | | fromJson | Creates a new PolicyDocument based on the object provided. | | organizationOnly | Grants permissions to any authenticated request to access as long as the request originates from principals that belong to the AWS organization specified in the `orgId` parameter. | --- ##### `fromJson` ```typescript import { AuthPolicyDocument } from 'cdk-vpclattice-alpha' AuthPolicyDocument.fromJson(obj: any) ``` Creates a new PolicyDocument based on the object provided. This will accept an object created from the `.toJSON()` call ###### `obj`^Required - *Type:* any the PolicyDocument in object form. --- ##### `organizationOnly` ```typescript import { AuthPolicyDocument } from 'cdk-vpclattice-alpha' AuthPolicyDocument.organizationOnly(orgId: string, resources?: string[]) ``` Grants permissions to any authenticated request to access as long as the request originates from principals that belong to the AWS organization specified in the `orgId` parameter. ###### `orgId`^Required - *Type:* string --- ###### `resources`^Optional - *Type:* string[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. | | isEmpty | boolean | Whether the policy document contains any statements. | | statementCount | number | The number of statements already added to this policy. | --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] The creation stack of this resolvable which will be appended to errors thrown during resolution. This may return an array with a single informational element indicating how to get this property populated, if it was skipped for performance reasons. --- ##### `isEmpty`^Required ```typescript public readonly isEmpty: boolean; ``` - *Type:* boolean Whether the policy document contains any statements. --- ##### `statementCount`^Required ```typescript public readonly statementCount: number; ``` - *Type:* number The number of statements already added to this policy. Can be used, for example, to generate unique "sid"s within the policy. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | AUTHENTICATED_ONLY | AuthPolicyDocument | Means that any request to the service or service network must contain a valid request signature that is computed using Signature Version 4 (SigV4). | | UNAUTHENTICATED | AuthPolicyDocument | Allows for Unauthenticated (Anonymous) Access to the Service Network. | --- ##### `AUTHENTICATED_ONLY`^Required ```typescript public readonly AUTHENTICATED_ONLY: AuthPolicyDocument; ``` - *Type:* AuthPolicyDocument Means that any request to the service or service network must contain a valid request signature that is computed using Signature Version 4 (SigV4). > [https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) --- ##### `UNAUTHENTICATED`^Required ```typescript public readonly UNAUTHENTICATED: AuthPolicyDocument; ``` - *Type:* AuthPolicyDocument Allows for Unauthenticated (Anonymous) Access to the Service Network. Anonymous principals are callers that don't sign their AWS requests with Signature Version 4 (SigV4), and are within a VPC that is connected to the service network. --- ### AuthPolicyStatement Helps you create Auth Policies using higher level abstractions which reflect common use cases. > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/auth-policies.html#example-auth-policies](https://docs.aws.amazon.com/vpc-lattice/latest/ug/auth-policies.html#example-auth-policies) #### Initializers ```typescript import { AuthPolicyStatement } from 'cdk-vpclattice-alpha' new AuthPolicyStatement(props?: PolicyStatementProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | aws-cdk-lib.aws_iam.PolicyStatementProps | *No description.* | --- ##### `props`^Optional - *Type:* aws-cdk-lib.aws_iam.PolicyStatementProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAccountCondition | Add a `StringEquals` condition that limits to a given account from `sts:ExternalId`. | | addAccountRootPrincipal | Adds an AWS account root user principal to this policy statement. | | addActions | Specify allowed actions into the "Action" section of the policy statement. | | addAllResources | Adds a ``"*"`` resource to this statement. | | addAnyPrincipal | Adds all identities in all accounts ("*") to this policy statement. | | addArnPrincipal | Specify a principal using the ARN identifier of the principal. | | addAwsAccountPrincipal | Specify AWS account ID as the principal entity to the "Principal" section of a policy statement. | | addCanonicalUserPrincipal | Adds a canonical user ID principal to this policy document. | | addCondition | Add a condition to the Policy. | | addConditions | Add multiple conditions to the Policy. | | addFederatedPrincipal | Adds a federated identity provider such as Amazon Cognito to this policy statement. | | addNotActions | Explicitly allow all actions except the specified list of actions into the "NotAction" section of the policy document. | | addNotPrincipals | Specify principals that is not allowed or denied access to the "NotPrincipal" section of a policy statement. | | addNotResources | Specify resources that this policy statement will not apply to in the "NotResource" section of this policy statement. | | addPrincipals | Adds principals to the "Principal" section of a policy statement. | | addResources | Specify resources that this policy statement applies into the "Resource" section of this policy statement. | | addServicePrincipal | Adds a service principal to this policy statement. | | addSourceAccountCondition | Add an `StringEquals` condition that limits to a given account from `aws:SourceAccount`. | | addSourceArnCondition | Add an `ArnEquals` condition that limits to a given resource arn from `aws:SourceArn`. | | copy | Create a new `PolicyStatement` with the same exact properties as this one, except for the overrides. | | freeze | Make the PolicyStatement immutable. | | toJSON | JSON-ify the statement. | | toStatementJson | JSON-ify the policy statement. | | toString | String representation of this policy statement. | | validateForAnyPolicy | Validate that the policy statement satisfies base requirements for a policy. | | validateForIdentityPolicy | Validate that the policy statement satisfies all requirements for an identity-based policy. | | validateForResourcePolicy | Validate that the policy statement satisfies all requirements for a resource-based policy. | --- ##### `addAccountCondition` ```typescript public addAccountCondition(accountId: string): void ``` Add a `StringEquals` condition that limits to a given account from `sts:ExternalId`. This method can only be called once: subsequent calls will overwrite earlier calls. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html) ###### `accountId`^Required - *Type:* string --- ##### `addAccountRootPrincipal` ```typescript public addAccountRootPrincipal(): void ``` Adds an AWS account root user principal to this policy statement. ##### `addActions` ```typescript public addActions(actions: string): void ``` Specify allowed actions into the "Action" section of the policy statement. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_action.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_action.html) ###### `actions`^Required - *Type:* string actions that will be allowed. --- ##### `addAllResources` ```typescript public addAllResources(): void ``` Adds a ``"*"`` resource to this statement. ##### `addAnyPrincipal` ```typescript public addAnyPrincipal(): void ``` Adds all identities in all accounts ("*") to this policy statement. ##### `addArnPrincipal` ```typescript public addArnPrincipal(arn: string): void ``` Specify a principal using the ARN identifier of the principal. You cannot specify IAM groups and instance profiles as principals. ###### `arn`^Required - *Type:* string ARN identifier of AWS account, IAM user, or IAM role (i.e. arn:aws:iam::123456789012:user/user-name). --- ##### `addAwsAccountPrincipal` ```typescript public addAwsAccountPrincipal(accountId: string): void ``` Specify AWS account ID as the principal entity to the "Principal" section of a policy statement. ###### `accountId`^Required - *Type:* string --- ##### `addCanonicalUserPrincipal` ```typescript public addCanonicalUserPrincipal(canonicalUserId: string): void ``` Adds a canonical user ID principal to this policy document. ###### `canonicalUserId`^Required - *Type:* string unique identifier assigned by AWS for every account. --- ##### `addCondition` ```typescript public addCondition(key: string, value: any): void ``` Add a condition to the Policy. If multiple calls are made to add a condition with the same operator and field, only the last one wins. For example: ```ts declare const stmt: iam.PolicyStatement; stmt.addCondition('StringEquals', { 'aws:SomeField': '1' }); stmt.addCondition('StringEquals', { 'aws:SomeField': '2' }); ``` Will end up with the single condition `StringEquals: { 'aws:SomeField': '2' }`. If you meant to add a condition to say that the field can be *either* `1` or `2`, write this: ```ts declare const stmt: iam.PolicyStatement; stmt.addCondition('StringEquals', { 'aws:SomeField': ['1', '2'] }); ``` ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addConditions` ```typescript public addConditions(conditions: {[ key: string ]: any}): void ``` Add multiple conditions to the Policy. See the `addCondition` function for a caveat on calling this method multiple times. ###### `conditions`^Required - *Type:* {[ key: string ]: any} --- ##### `addFederatedPrincipal` ```typescript public addFederatedPrincipal(federated: any, conditions: {[ key: string ]: any}): void ``` Adds a federated identity provider such as Amazon Cognito to this policy statement. ###### `federated`^Required - *Type:* any federated identity provider (i.e. 'cognito-identity.amazonaws.com'). --- ###### `conditions`^Required - *Type:* {[ key: string ]: any} The conditions under which the policy is in effect. See [the IAM documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html). --- ##### `addNotActions` ```typescript public addNotActions(notActions: string): void ``` Explicitly allow all actions except the specified list of actions into the "NotAction" section of the policy document. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notaction.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notaction.html) ###### `notActions`^Required - *Type:* string actions that will be denied. All other actions will be permitted. --- ##### `addNotPrincipals` ```typescript public addNotPrincipals(notPrincipals: IPrincipal): void ``` Specify principals that is not allowed or denied access to the "NotPrincipal" section of a policy statement. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notprincipal.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notprincipal.html) ###### `notPrincipals`^Required - *Type:* aws-cdk-lib.aws_iam.IPrincipal IAM principals that will be denied access. --- ##### `addNotResources` ```typescript public addNotResources(arns: string): void ``` Specify resources that this policy statement will not apply to in the "NotResource" section of this policy statement. All resources except the specified list will be matched. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notresource.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notresource.html) ###### `arns`^Required - *Type:* string Amazon Resource Names (ARNs) of the resources that this policy statement does not apply to. --- ##### `addPrincipals` ```typescript public addPrincipals(principals: IPrincipal): void ``` Adds principals to the "Principal" section of a policy statement. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) ###### `principals`^Required - *Type:* aws-cdk-lib.aws_iam.IPrincipal IAM principals that will be added. --- ##### `addResources` ```typescript public addResources(arns: string): void ``` Specify resources that this policy statement applies into the "Resource" section of this policy statement. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_resource.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_resource.html) ###### `arns`^Required - *Type:* string Amazon Resource Names (ARNs) of the resources that this policy statement applies to. --- ##### `addServicePrincipal` ```typescript public addServicePrincipal(service: string, opts?: ServicePrincipalOpts): void ``` Adds a service principal to this policy statement. ###### `service`^Required - *Type:* string the service name for which a service principal is requested (e.g: `s3.amazonaws.com`). --- ###### `opts`^Optional - *Type:* aws-cdk-lib.aws_iam.ServicePrincipalOpts options for adding the service principal (such as specifying a principal in a different region). --- ##### `addSourceAccountCondition` ```typescript public addSourceAccountCondition(accountId: string): void ``` Add an `StringEquals` condition that limits to a given account from `aws:SourceAccount`. This method can only be called once: subsequent calls will overwrite earlier calls. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) ###### `accountId`^Required - *Type:* string --- ##### `addSourceArnCondition` ```typescript public addSourceArnCondition(arn: string): void ``` Add an `ArnEquals` condition that limits to a given resource arn from `aws:SourceArn`. This method can only be called once: subsequent calls will overwrite earlier calls. > [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) ###### `arn`^Required - *Type:* string --- ##### `copy` ```typescript public copy(overrides?: PolicyStatementProps): PolicyStatement ``` Create a new `PolicyStatement` with the same exact properties as this one, except for the overrides. ###### `overrides`^Optional - *Type:* aws-cdk-lib.aws_iam.PolicyStatementProps --- ##### `freeze` ```typescript public freeze(): PolicyStatement ``` Make the PolicyStatement immutable. After calling this, any of the `addXxx()` methods will throw an exception. Libraries that lazily generate statement bodies can override this method to fill the actual PolicyStatement fields. Be aware that this method may be called multiple times. ##### `toJSON` ```typescript public toJSON(): any ``` JSON-ify the statement. Used when JSON.stringify() is called ##### `toStatementJson` ```typescript public toStatementJson(): any ``` JSON-ify the policy statement. Used when JSON.stringify() is called ##### `toString` ```typescript public toString(): string ``` String representation of this policy statement. ##### `validateForAnyPolicy` ```typescript public validateForAnyPolicy(): string[] ``` Validate that the policy statement satisfies base requirements for a policy. ##### `validateForIdentityPolicy` ```typescript public validateForIdentityPolicy(): string[] ``` Validate that the policy statement satisfies all requirements for an identity-based policy. ##### `validateForResourcePolicy` ```typescript public validateForResourcePolicy(): string[] ``` Validate that the policy statement satisfies all requirements for a resource-based policy. #### Static Functions | **Name** | **Description** | | --- | --- | | fromJson | Creates a new PolicyStatement based on the object provided. | | allowAnonymous | Grants permissions to both authenticated and unauthenticated (anonymous) requests. | | allowOnlyAuthenticated | Grants permissions to any authenticated request. | | allowOnlyOrganization | Creates an IAM Auth policy which limits access to requests which originate from principals that belong to the AWS organization specified. | | allowOnlyRole | Grants permissions to any authenticated request that uses the IAM role specified. | | allowVpc | Grants permissions to authenticated requests originating from principals in the specified VPC. | --- ##### `fromJson` ```typescript import { AuthPolicyStatement } from 'cdk-vpclattice-alpha' AuthPolicyStatement.fromJson(obj: any) ``` Creates a new PolicyStatement based on the object provided. This will accept an object created from the `.toJSON()` call ###### `obj`^Required - *Type:* any the PolicyStatement in object form. --- ##### `allowAnonymous` ```typescript import { AuthPolicyStatement } from 'cdk-vpclattice-alpha' AuthPolicyStatement.allowAnonymous(resources?: string[]) ``` Grants permissions to both authenticated and unauthenticated (anonymous) requests. ###### `resources`^Optional - *Type:* string[] optional list of resources to limit the statement to (defaults to "*"). --- ##### `allowOnlyAuthenticated` ```typescript import { AuthPolicyStatement } from 'cdk-vpclattice-alpha' AuthPolicyStatement.allowOnlyAuthenticated(resources?: string[]) ``` Grants permissions to any authenticated request. ###### `resources`^Optional - *Type:* string[] optional list of resources to limit the statement to (defaults to "*"). --- ##### `allowOnlyOrganization` ```typescript import { AuthPolicyStatement } from 'cdk-vpclattice-alpha' AuthPolicyStatement.allowOnlyOrganization(orgId: string, resources?: string[]) ``` Creates an IAM Auth policy which limits access to requests which originate from principals that belong to the AWS organization specified. ###### `orgId`^Required - *Type:* string The AWS Organization ID to limit access to. --- ###### `resources`^Optional - *Type:* string[] optional list of resources to limit the statement to (defaults to "*"). --- ##### `allowOnlyRole` ```typescript import { AuthPolicyStatement } from 'cdk-vpclattice-alpha' AuthPolicyStatement.allowOnlyRole(role: IRole, resources?: string[]) ``` Grants permissions to any authenticated request that uses the IAM role specified. ###### `role`^Required - *Type:* aws-cdk-lib.aws_iam.IRole the AWS IAM Role. --- ###### `resources`^Optional - *Type:* string[] optional list of resources to limit the statement to (defaults to "*"). --- ##### `allowVpc` ```typescript import { AuthPolicyStatement } from 'cdk-vpclattice-alpha' AuthPolicyStatement.allowVpc(vpc: IVpc, resources?: string[], authenticated?: boolean) ``` Grants permissions to authenticated requests originating from principals in the specified VPC. ###### `vpc`^Required - *Type:* aws-cdk-lib.aws_ec2.IVpc the VPC to restrict requests from. --- ###### `resources`^Optional - *Type:* string[] optional list of resources to limit the statement to (defaults to "*"). --- ###### `authenticated`^Optional - *Type:* boolean --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | actions | string[] | The Actions added to this statement. | | conditions | any | The conditions added to this statement. | | frozen | boolean | Whether the PolicyStatement has been frozen. | | hasPrincipal | boolean | Indicates if this permission has a "Principal" section. | | hasResource | boolean | Indicates if this permission has at least one resource associated with it. | | notActions | string[] | The NotActions added to this statement. | | notPrincipals | aws-cdk-lib.aws_iam.IPrincipal[] | The NotPrincipals added to this statement. | | notResources | string[] | The NotResources added to this statement. | | principals | aws-cdk-lib.aws_iam.IPrincipal[] | The Principals added to this statement. | | resources | string[] | The Resources added to this statement. | | effect | aws-cdk-lib.aws_iam.Effect | Whether to allow or deny the actions in this statement Set effect for this statement. | | sid | string | Statement ID for this statement Set Statement ID for this statement. | --- ##### `actions`^Required ```typescript public readonly actions: string[]; ``` - *Type:* string[] The Actions added to this statement. --- ##### `conditions`^Required ```typescript public readonly conditions: any; ``` - *Type:* any The conditions added to this statement. --- ##### `frozen`^Required ```typescript public readonly frozen: boolean; ``` - *Type:* boolean Whether the PolicyStatement has been frozen. The statement object is frozen when `freeze()` is called. --- ##### `hasPrincipal`^Required ```typescript public readonly hasPrincipal: boolean; ``` - *Type:* boolean Indicates if this permission has a "Principal" section. --- ##### `hasResource`^Required ```typescript public readonly hasResource: boolean; ``` - *Type:* boolean Indicates if this permission has at least one resource associated with it. --- ##### `notActions`^Required ```typescript public readonly notActions: string[]; ``` - *Type:* string[] The NotActions added to this statement. --- ##### `notPrincipals`^Required ```typescript public readonly notPrincipals: IPrincipal[]; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal[] The NotPrincipals added to this statement. --- ##### `notResources`^Required ```typescript public readonly notResources: string[]; ``` - *Type:* string[] The NotResources added to this statement. --- ##### `principals`^Required ```typescript public readonly principals: IPrincipal[]; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal[] The Principals added to this statement. --- ##### `resources`^Required ```typescript public readonly resources: string[]; ``` - *Type:* string[] The Resources added to this statement. --- ##### `effect`^Required ```typescript public readonly effect: Effect; ``` - *Type:* aws-cdk-lib.aws_iam.Effect Whether to allow or deny the actions in this statement Set effect for this statement. --- ##### `sid`^Optional ```typescript public readonly sid: string; ``` - *Type:* string Statement ID for this statement Set Statement ID for this statement. --- ### LoggingDestination Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and/or Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. At most one destination per destination type. > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/monitoring-access-logs.html](https://docs.aws.amazon.com/vpc-lattice/latest/ug/monitoring-access-logs.html) #### Initializers ```typescript import { LoggingDestination } from 'cdk-vpclattice-alpha' new LoggingDestination() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | cloudwatch | Send logs to Amazon CloudWatch. | | kinesis | Use Amazon Kinesis Data Firehose for delivering real-time streaming data to destinations such as Amazon S3, Amazon Redshift, Amazon OpenSearch, or any custom HTTP endpoint. | | s3 | Send logs to Amazon S3. | --- ##### `cloudwatch` ```typescript import { LoggingDestination } from 'cdk-vpclattice-alpha' LoggingDestination.cloudwatch(logGroup: ILogGroup) ``` Send logs to Amazon CloudWatch. ###### `logGroup`^Required - *Type:* aws-cdk-lib.aws_logs.ILogGroup the log group in CloudWatch Logs to use. --- ##### `kinesis` ```typescript import { LoggingDestination } from 'cdk-vpclattice-alpha' LoggingDestination.kinesis(stream: IStream) ``` Use Amazon Kinesis Data Firehose for delivering real-time streaming data to destinations such as Amazon S3, Amazon Redshift, Amazon OpenSearch, or any custom HTTP endpoint. ###### `stream`^Required - *Type:* aws-cdk-lib.aws_kinesis.IStream the delivery stream to send logs to. --- ##### `s3` ```typescript import { LoggingDestination } from 'cdk-vpclattice-alpha' LoggingDestination.s3(bucket: IBucket) ``` Send logs to Amazon S3. ###### `bucket`^Required - *Type:* aws-cdk-lib.aws_s3.IBucket the S3 bucket to send logs to. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | addr | string | unique addr of the destination. | | arn | string | An Arn of the destination. | | destinationType | LoggingDestinationType | Type of the destination. | | name | string | A name of the destination. | --- ##### `addr`^Required ```typescript public readonly addr: string; ``` - *Type:* string unique addr of the destination. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string An Arn of the destination. --- ##### `destinationType`^Required ```typescript public readonly destinationType: LoggingDestinationType; ``` - *Type:* LoggingDestinationType Type of the destination. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string A name of the destination. --- ### MatchHeader - *Implements:* IMatchHeader #### Initializers ```typescript import { MatchHeader } from 'cdk-vpclattice-alpha' new MatchHeader(name: string, match: {[ key: string ]: string}, caseSensitive: boolean) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | *No description.* | | match | {[ key: string ]: string} | *No description.* | | caseSensitive | boolean | *No description.* | --- ##### `name`^Required - *Type:* string --- ##### `match`^Required - *Type:* {[ key: string ]: string} --- ##### `caseSensitive`^Required - *Type:* boolean --- #### Static Functions | **Name** | **Description** | | --- | --- | | contains | Matches if the header value contains the given value. | | exact | Matches if the header value is exactly the given value. | | prefix | Matches if the header value starts with the given value. | --- ##### `contains` ```typescript import { MatchHeader } from 'cdk-vpclattice-alpha' MatchHeader.contains(header: string, ruleMatchName?: string, caseSensitive?: boolean) ``` Matches if the header value contains the given value. ###### `header`^Required - *Type:* string the header to match. --- ###### `ruleMatchName`^Optional - *Type:* string the name of the rule match. --- ###### `caseSensitive`^Optional - *Type:* boolean whether the match should be case sensitive. --- ##### `exact` ```typescript import { MatchHeader } from 'cdk-vpclattice-alpha' MatchHeader.exact(header: string, ruleMatchName?: string, caseSensitive?: boolean) ``` Matches if the header value is exactly the given value. ###### `header`^Required - *Type:* string the header to match. --- ###### `ruleMatchName`^Optional - *Type:* string the name of the rule match. --- ###### `caseSensitive`^Optional - *Type:* boolean whether the match should be case sensitive. --- ##### `prefix` ```typescript import { MatchHeader } from 'cdk-vpclattice-alpha' MatchHeader.prefix(header: string, ruleMatchName?: string, caseSensitive?: boolean) ``` Matches if the header value starts with the given value. ###### `header`^Required - *Type:* string the header to match. --- ###### `ruleMatchName`^Optional - *Type:* string the name of the rule match. --- ###### `caseSensitive`^Optional - *Type:* boolean whether the match should be case sensitive. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | caseSensitive | boolean | *No description.* | | match | {[ key: string ]: string} | *No description.* | | name | string | *No description.* | --- ##### `caseSensitive`^Required ```typescript public readonly caseSensitive: boolean; ``` - *Type:* boolean --- ##### `match`^Required ```typescript public readonly match: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ### MatchPath - *Implements:* IMatchPath #### Initializers ```typescript import { MatchPath } from 'cdk-vpclattice-alpha' new MatchPath(match: {[ key: string ]: string}, caseSensitive: boolean) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | match | {[ key: string ]: string} | *No description.* | | caseSensitive | boolean | *No description.* | --- ##### `match`^Required - *Type:* {[ key: string ]: string} --- ##### `caseSensitive`^Required - *Type:* boolean --- #### Static Functions | **Name** | **Description** | | --- | --- | | exact | Matches if the path is exactly the given value. | | prefix | Matches if the path starts with the given value. | --- ##### `exact` ```typescript import { MatchPath } from 'cdk-vpclattice-alpha' MatchPath.exact(path: string, caseSensitive?: boolean) ``` Matches if the path is exactly the given value. ###### `path`^Required - *Type:* string the path to match. --- ###### `caseSensitive`^Optional - *Type:* boolean whether the match should be case sensitive. --- ##### `prefix` ```typescript import { MatchPath } from 'cdk-vpclattice-alpha' MatchPath.prefix(path: string, caseSensitive?: boolean) ``` Matches if the path starts with the given value. ###### `path`^Required - *Type:* string the path to match. --- ###### `caseSensitive`^Optional - *Type:* boolean whether the match should be case sensitive. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | caseSensitive | boolean | *No description.* | | match | {[ key: string ]: string} | *No description.* | --- ##### `caseSensitive`^Required ```typescript public readonly caseSensitive: boolean; ``` - *Type:* boolean --- ##### `match`^Required ```typescript public readonly match: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ### RuleAction - *Implements:* IRuleAction #### Initializers ```typescript import { RuleAction } from 'cdk-vpclattice-alpha' new RuleAction(action: IRuleAction) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | action | IRuleAction | *No description.* | --- ##### `action`^Required - *Type:* IRuleAction --- #### Static Functions | **Name** | **Description** | | --- | --- | | fixedResponseAction | Return a fixed response. | | forwardAction | Forward to one or more Target Groups. | | weightedForwardAction | Forward to one or more Target Groups which are weighted differently. | --- ##### `fixedResponseAction` ```typescript import { RuleAction } from 'cdk-vpclattice-alpha' RuleAction.fixedResponseAction(statusCode: HttpFixedResponse) ``` Return a fixed response. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-fixedresponse.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-fixedresponse.html) ###### `statusCode`^Required - *Type:* HttpFixedResponse --- ##### `forwardAction` ```typescript import { RuleAction } from 'cdk-vpclattice-alpha' RuleAction.forwardAction(targetGroup: ITargetGroup, weight?: number) ``` Forward to one or more Target Groups. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-forward.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-forward.html) ###### `targetGroup`^Required - *Type:* ITargetGroup --- ###### `weight`^Optional - *Type:* number --- ##### `weightedForwardAction` ```typescript import { RuleAction } from 'cdk-vpclattice-alpha' RuleAction.weightedForwardAction(weightedTargetGroups: WeightedTargetGroup[]) ``` Forward to one or more Target Groups which are weighted differently. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-forward.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-forward.html) ###### `weightedTargetGroups`^Required - *Type:* WeightedTargetGroup[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fixedResponse | aws-cdk-lib.aws_vpclattice.CfnRule.FixedResponseProperty | *No description.* | | forward | aws-cdk-lib.aws_vpclattice.CfnRule.ForwardProperty | *No description.* | --- ##### `fixedResponse`^Optional ```typescript public readonly fixedResponse: FixedResponseProperty; ``` - *Type:* aws-cdk-lib.aws_vpclattice.CfnRule.FixedResponseProperty --- ##### `forward`^Optional ```typescript public readonly forward: ForwardProperty; ``` - *Type:* aws-cdk-lib.aws_vpclattice.CfnRule.ForwardProperty --- ### RuleMatch #### Initializers ```typescript import { RuleMatch } from 'cdk-vpclattice-alpha' new RuleMatch(method?: HttpMethod, headerMatches?: IMatchHeader[], pathMatch?: IMatchPath) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | method | HttpMethod | *No description.* | | headerMatches | IMatchHeader[] | *No description.* | | pathMatch | IMatchPath | *No description.* | --- ##### `method`^Optional - *Type:* HttpMethod --- ##### `headerMatches`^Optional - *Type:* IMatchHeader[] --- ##### `pathMatch`^Optional - *Type:* IMatchPath --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | headerMatches | IMatchHeader[] | *No description.* | | method | HttpMethod | *No description.* | | pathMatch | IMatchPath | *No description.* | --- ##### `headerMatches`^Optional ```typescript public readonly headerMatches: IMatchHeader[]; ``` - *Type:* IMatchHeader[] --- ##### `method`^Optional ```typescript public readonly method: HttpMethod; ``` - *Type:* HttpMethod --- ##### `pathMatch`^Optional ```typescript public readonly pathMatch: IMatchPath; ``` - *Type:* IMatchPath --- ## Protocols ### IListener - *Extends:* aws-cdk-lib.IResource - *Implemented By:* Listener, IListener Create a VPC Lattice Listener. It is simply a process that checks for connection requests, and routes them to targets in a target group according to the defined rules. Implemented by `Listener`. > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html](https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html) #### Methods | **Name** | **Description** | | --- | --- | | addRule | Add A Rule to the Listener. | --- ##### `addRule` ```typescript public addRule(rule: AddRuleProps): void ``` Add A Rule to the Listener. ###### `rule`^Required - *Type:* AddRuleProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | listenerArn | string | The Amazon Resource Name (ARN) of the service. | | listenerId | string | The Id of the Service Network. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `listenerArn`^Required ```typescript public readonly listenerArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the service. --- ##### `listenerId`^Required ```typescript public readonly listenerId: string; ``` - *Type:* string The Id of the Service Network. --- ### IMatchHeader - *Implemented By:* MatchHeader, IMatchHeader #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | caseSensitive | boolean | *No description.* | | match | {[ key: string ]: string} | *No description.* | | name | string | *No description.* | --- ##### `caseSensitive`^Required ```typescript public readonly caseSensitive: boolean; ``` - *Type:* boolean --- ##### `match`^Required ```typescript public readonly match: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ### IMatchPath - *Implemented By:* MatchPath, IMatchPath #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | caseSensitive | boolean | *No description.* | | match | {[ key: string ]: string} | *No description.* | --- ##### `caseSensitive`^Required ```typescript public readonly caseSensitive: boolean; ``` - *Type:* boolean --- ##### `match`^Required ```typescript public readonly match: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ### IRuleAction - *Implemented By:* RuleAction, IRuleAction #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fixedResponse | aws-cdk-lib.aws_vpclattice.CfnRule.FixedResponseProperty | *No description.* | | forward | aws-cdk-lib.aws_vpclattice.CfnRule.ForwardProperty | *No description.* | --- ##### `fixedResponse`^Optional ```typescript public readonly fixedResponse: FixedResponseProperty; ``` - *Type:* aws-cdk-lib.aws_vpclattice.CfnRule.FixedResponseProperty --- ##### `forward`^Optional ```typescript public readonly forward: ForwardProperty; ``` - *Type:* aws-cdk-lib.aws_vpclattice.CfnRule.ForwardProperty --- ### IService - *Extends:* aws-cdk-lib.IResource - *Implemented By:* Service, IService Represents a Vpc Lattice Service. Implemented by `Service`. #### Methods | **Name** | **Description** | | --- | --- | | associateWithServiceNetwork | Associate the service with a Service Network. | --- ##### `associateWithServiceNetwork` ```typescript public associateWithServiceNetwork(serviceNetwork: IServiceNetwork): void ``` Associate the service with a Service Network. ###### `serviceNetwork`^Required - *Type:* IServiceNetwork --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | serviceArn | string | The Amazon Resource Name (ARN) of the service. | | serviceId | string | The Id of the service. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `serviceArn`^Required ```typescript public readonly serviceArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the service. --- *Example* ```typescript "arn:aws:vpc-lattice:eu-central-1:123456789123:service/svc-03537cbda06ea0823" ``` ##### `serviceId`^Required ```typescript public readonly serviceId: string; ``` - *Type:* string The Id of the service. --- *Example* ```typescript "svc-03537cbda06ea0823" ``` ### IServiceNetwork - *Extends:* aws-cdk-lib.IResource - *Implemented By:* ServiceNetwork, IServiceNetwork Represents a VPC Lattice Service Network. Implemented by `ServiceNetwork`. #### Methods | **Name** | **Description** | | --- | --- | | associateService | Associate a Lattice Service to the Service Network. | | associateVPC | Associate a VPC with the Service Network. | --- ##### `associateService` ```typescript public associateService(service: IService): void ``` Associate a Lattice Service to the Service Network. ###### `service`^Required - *Type:* IService --- ##### `associateVPC` ```typescript public associateVPC(props: AssociateVPCProps): void ``` Associate a VPC with the Service Network. ###### `props`^Required - *Type:* AssociateVPCProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | serviceNetworkArn | string | The Amazon Resource Name (ARN) of the service network. | | serviceNetworkId | string | The Id of the Service Network. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `serviceNetworkArn`^Required ```typescript public readonly serviceNetworkArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the service network. --- ##### `serviceNetworkId`^Required ```typescript public readonly serviceNetworkId: string; ``` - *Type:* string The Id of the Service Network. --- *Example* ```typescript "sn-0123456789abcdef0" ``` ### ITargetGroup - *Extends:* aws-cdk-lib.IResource - *Implemented By:* AlbTargetGroup, InstanceTargetGroup, IpTargetGroup, LambdaTargetGroup, TargetGroupBase, ITargetGroup Create a vpc lattice TargetGroup. Implemented by `TargetGroup`. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | targetGroupArn | string | The Arn of the target group. | | targetGroupId | string | The id of the target group. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `targetGroupArn`^Required ```typescript public readonly targetGroupArn: string; ``` - *Type:* string The Arn of the target group. --- ##### `targetGroupId`^Required ```typescript public readonly targetGroupId: string; ``` - *Type:* string The id of the target group. --- ## Enums ### AuthType Specifies the authentication and authorization that manages client access to the service or service network. #### Members | **Name** | **Description** | | --- | --- | | NONE | No Authentication or Authorization. | | AWS_IAM | Use VPC Lattice Auth Policy to control access. | --- ##### `NONE` No Authentication or Authorization. If an auth policy is present, it is inactive. --- ##### `AWS_IAM` Use VPC Lattice Auth Policy to control access. If enabled and a policy is not attached, all traffic will be denied by default regardless of the identity or service level permissions. --- ### HealthCheckProtocol #### Members | **Name** | **Description** | | --- | --- | | HTTP | HTTP. | | HTTPS | HTTPS. | --- ##### `HTTP` HTTP. --- ##### `HTTPS` HTTPS. --- ### HealthCheckProtocolVersion #### Members | **Name** | **Description** | | --- | --- | | HTTP1 | Send requests to targets using HTTP/1.1. Supported when the request protocol is HTTP/1.1 or HTTP/2. | | HTTP2 | Send requests to targets using HTTP/2. | --- ##### `HTTP1` Send requests to targets using HTTP/1.1. Supported when the request protocol is HTTP/1.1 or HTTP/2. --- ##### `HTTP2` Send requests to targets using HTTP/2. Supported when the request protocol is HTTP/2 or gRPC, but gRPC-specific features are not available. --- ### HttpFixedResponse Fixed response codes. #### Members | **Name** | **Description** | | --- | --- | | OK | OK 200. | | CREATED | Created 201. | | ACCEPTED | Accepted. | | NO_CONTENT | No Content 204. | | NOT_FOUND | Not Found 404. | | INTERNAL_SERVER_ERROR | Internal server error 500. | --- ##### `OK` OK 200. --- ##### `CREATED` Created 201. --- ##### `ACCEPTED` Accepted. --- ##### `NO_CONTENT` No Content 204. --- ##### `NOT_FOUND` Not Found 404. --- ##### `INTERNAL_SERVER_ERROR` Internal server error 500. --- ### HttpMethod HTTP Methods. #### Members | **Name** | **Description** | | --- | --- | | GET | GET Method. | | POST | POST Method. | | PUT | PUT Method. | | DELETE | Delete Method. | | PATCH | PATCH Method. | | HEAD | Head Method. | | CONNECT | Connect Method. | | OPTIONS | Options Method. | | TRACE | Trace Method. | --- ##### `GET` GET Method. --- ##### `POST` POST Method. --- ##### `PUT` PUT Method. --- ##### `DELETE` Delete Method. --- ##### `PATCH` PATCH Method. --- ##### `HEAD` Head Method. --- ##### `CONNECT` Connect Method. --- ##### `OPTIONS` Options Method. --- ##### `TRACE` Trace Method. --- ### IpAddressType The type of IP Address Protocol. #### Members | **Name** | **Description** | | --- | --- | | IPV4 | IPv4 (Internet Protocol version 4). | | IPV6 | IPv6 (Internet Protocol version 6). | --- ##### `IPV4` IPv4 (Internet Protocol version 4). --- ##### `IPV6` IPv6 (Internet Protocol version 6). --- ### LambdaEventStructureVersion #### Members | **Name** | **Description** | | --- | --- | | V1 | Version 1.0. | | V2 | Version 2.0. | --- ##### `V1` Version 1.0. --- ##### `V2` Version 2.0. --- ### ListenerProtocol It is not required that the listener and target group protocols match. VPC Lattice manages the entire process of upgrading and downgrading between protocols and versions. #### Members | **Name** | **Description** | | --- | --- | | HTTP | HTTP Protocol. | | HTTPS | HTTPS Protocol VPC Lattice will provision and manage a TLS certificate that is associated with the VPC Lattice generated FQDN. | | TLS_PASSTHROUGH | TLS Passthrough. | --- ##### `HTTP` HTTP Protocol. > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/http-listeners.html](https://docs.aws.amazon.com/vpc-lattice/latest/ug/http-listeners.html) --- ##### `HTTPS` HTTPS Protocol VPC Lattice will provision and manage a TLS certificate that is associated with the VPC Lattice generated FQDN. > [https://docs.aws.amazon.com/vpc-lattice/latest/ug/https-listeners.html](https://docs.aws.amazon.com/vpc-lattice/latest/ug/https-listeners.html) --- ##### `TLS_PASSTHROUGH` TLS Passthrough. This ensures that your application decrypts the encrypted traffic instead of VPC Lattice. --- ### LoggingDestinationType #### Members | **Name** | **Description** | | --- | --- | | S3 | *No description.* | | CLOUDWATCH_LOGS | *No description.* | | KINESIS_DATA_STREAM | *No description.* | --- ##### `S3` --- ##### `CLOUDWATCH_LOGS` --- ##### `KINESIS_DATA_STREAM` --- ### MappingRecordType #### Members | **Name** | **Description** | | --- | --- | | CNAME | *No description.* | | ALIAS | *No description.* | --- ##### `CNAME` --- ##### `ALIAS` --- ### RequestProtocol HTTP/HTTPS methods. #### Members | **Name** | **Description** | | --- | --- | | HTTP | HTTP Protocol (Unencrypted traffic). | | HTTPS | HTTPS Protocol (Encrypted traffic - TLS termination). | | TCP | TCP Protocol (Encrypted traffic - TLS passthrough). | --- ##### `HTTP` HTTP Protocol (Unencrypted traffic). --- ##### `HTTPS` HTTPS Protocol (Encrypted traffic - TLS termination). --- ##### `TCP` TCP Protocol (Encrypted traffic - TLS passthrough). --- ### RequestProtocolVersion ProtocolVersion. #### Members | **Name** | **Description** | | --- | --- | | HTTP1 | Http1. | | HTTP2 | Http2. | | GRPC | GRPC. | --- ##### `HTTP1` Http1. --- ##### `HTTP2` Http2. --- ##### `GRPC` GRPC. --- ### TargetType #### Members | **Name** | **Description** | | --- | --- | | LAMBDA | Lambda Target. | | IP | IP Address Target. | | INSTANCE | EC2 Instance Targets. | | ALB | Application Load Balancer Target. | --- ##### `LAMBDA` Lambda Target. --- ##### `IP` IP Address Target. --- ##### `INSTANCE` EC2 Instance Targets. --- ##### `ALB` Application Load Balancer Target. ---