# aws-vpclattice-prealpha
# vpcLattice L2 Construct
- [Project Information](#project-information)
- [Example Impleentation](#example-implementation)
- [API Design](#proposed-api-design-for-vpclattice)
- [FAQ](#faq)
- [Acceptance](#acceptance)
---
## Project Information
**Status** (DRAFT)
**Original Author(s):** @mrpackethead, , @taylaand, @nbaillie
**Tracking Issue:** #502
**API Bar Raiser:** @TheRealAmazonKendra
**Public Issues ( aws-cdk)**
* (vpclattice): L2 for Amazon VPC Lattice #25452
**Prototype Code**
- https://github.com/raindancers/aws-cdk/tree/mrpackethead/aws-vpclattice-alpha/packages/%40aws-cdk/aws-vpclattice-alpha
**Example implementation**
- https://github.com/raindancers/vpclattice-prealpha-demo
**Blog**
**VpcLattice**
Amazon VPC Lattice is an application networking service that consistently connects, monitors, and secures communications between your services, helping to improve productivity so that your developers can focus on building features that matter to your business. You can define policies for network traffic management, access, and monitoring to connect compute services in a simplified and consistent way across instances, containers, and serverless applications.
The L2 Construct seeks to assist the consumer to create a lattice service easily by abstracting some of the detail. The major part of this is in creating the underlying auth policy and listener rules together, as their is significant intersection in the properties require for both.
# API Reference
## Constructs
### AssociateVpc
Associate a VPO with Lattice Service Network.
#### Initializers
```typescript
import { AssociateVpc } from 'aws-vpclattice-prealpha'
new AssociateVpc(scope: Construct, id: string, props: AssociateVpcProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | AssociateVpcProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* AssociateVpcProps
---
#### 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 { AssociateVpc } from 'aws-vpclattice-prealpha'
AssociateVpc.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { AssociateVpc } from 'aws-vpclattice-prealpha'
AssociateVpc.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `isResource`
```typescript
import { AssociateVpc } from 'aws-vpclattice-prealpha'
AssociateVpc.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.
---
### Listener
- *Implements:* IListener
This class should not be called directly.
Use the .addListener() Method on an instance of LatticeService
Creates a vpcLattice Listener
#### Initializers
```typescript
import { Listener } from 'aws-vpclattice-prealpha'
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. |
| addListenerRule | add 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
---
##### `addListenerRule`
```typescript
public addListenerRule(props: RuleProp): void
```
add a rule to the listener.
###### `props`Required
- *Type:* RuleProp
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 'aws-vpclattice-prealpha'
Listener.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { Listener } from 'aws-vpclattice-prealpha'
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 'aws-vpclattice-prealpha'
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. |
| listenerArn | string | THe Arn of the Listener. |
| listenerId | string | The Id of the Listener. |
| listenerPrioritys | number[] | A list of prioritys, to check for duplicates. |
| service | IService | The service this listener is attached to. |
---
##### `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 Arn of the Listener.
---
##### `listenerId`Required
```typescript
public readonly listenerId: string;
```
- *Type:* string
The Id of the Listener.
---
##### `listenerPrioritys`Required
```typescript
public readonly listenerPrioritys: number[];
```
- *Type:* number[]
A list of prioritys, to check for duplicates.
---
##### `service`Required
```typescript
public readonly service: IService;
```
- *Type:* IService
The service this listener is attached to.
---
### Service
- *Implements:* IService
Create a vpcLattice Service.
#### Initializers
```typescript
import { Service } from 'aws-vpclattice-prealpha'
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. |
| addPolicyStatement | Add a PolicyStatement. |
| applyAuthPolicy | apply an authpolicy. |
| associateWithServiceNetwork | Associate with a Service Network. |
| grantAccess | .grantAccess on a lattice service, will permit the principals to access all of the service. Consider using more granual permissions at the rule level. |
| shareToAccounts | Share the service to other accounts via RAM. |
---
##### `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
---
##### `addPolicyStatement`
```typescript
public addPolicyStatement(statement: PolicyStatement): void
```
Add a PolicyStatement.
###### `statement`Required
- *Type:* aws-cdk-lib.aws_iam.PolicyStatement
---
##### `applyAuthPolicy`
```typescript
public applyAuthPolicy(): PolicyDocument
```
apply an authpolicy.
##### `associateWithServiceNetwork`
```typescript
public associateWithServiceNetwork(serviceNetwork: IServiceNetwork): void
```
Associate 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 granual permissions at the rule level.
###### `principals`Required
- *Type:* aws-cdk-lib.aws_iam.IPrincipal[]
---
##### `shareToAccounts`
```typescript
public shareToAccounts(props: ShareServiceProps): void
```
Share the service to other accounts via RAM.
###### `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. |
| fromServiceId | import a service from Id. |
---
##### ~~`isConstruct`~~
```typescript
import { Service } from 'aws-vpclattice-prealpha'
Service.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { Service } from 'aws-vpclattice-prealpha'
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 'aws-vpclattice-prealpha'
Service.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `fromServiceId`
```typescript
import { Service } from 'aws-vpclattice-prealpha'
Service.fromServiceId(scope: Construct, id: string, serviceId: string)
```
import a service from Id.
###### `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. |
| imported | boolean | Imported. |
| serviceArn | string | The Arn of the Service. |
| serviceId | string | The Id of the Service. |
| orgId | string | the discovered OrgId. |
| authPolicy | aws-cdk-lib.aws_iam.PolicyDocument | The auth Policy for the service. |
| authType | string | The authType of the service. |
| certificate | aws-cdk-lib.aws_certificatemanager.Certificate | A certificate that may be used by the service. |
| customDomain | string | A custom Domain used by the service. |
| hostedZone | aws-cdk-lib.aws_route53.IHostedZone | A DNS Entry for the service. |
| name | string | A name for 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.
---
##### `imported`Required
```typescript
public readonly imported: boolean;
```
- *Type:* boolean
Imported.
---
##### `serviceArn`Required
```typescript
public readonly serviceArn: string;
```
- *Type:* string
The Arn of the Service.
---
##### `serviceId`Required
```typescript
public readonly serviceId: string;
```
- *Type:* string
The Id of the Service.
---
##### `orgId`Optional
```typescript
public readonly orgId: string;
```
- *Type:* string
the discovered OrgId.
---
##### `authPolicy`Required
```typescript
public readonly authPolicy: PolicyDocument;
```
- *Type:* aws-cdk-lib.aws_iam.PolicyDocument
The auth Policy for the service.
---
##### `authType`Optional
```typescript
public readonly authType: string;
```
- *Type:* string
The authType of the service.
---
##### `certificate`Optional
```typescript
public readonly certificate: Certificate;
```
- *Type:* aws-cdk-lib.aws_certificatemanager.Certificate
A certificate that may be used by the service.
---
##### `customDomain`Optional
```typescript
public readonly customDomain: string;
```
- *Type:* string
A custom Domain used by the service.
---
##### `hostedZone`Optional
```typescript
public readonly hostedZone: IHostedZone;
```
- *Type:* aws-cdk-lib.aws_route53.IHostedZone
A DNS Entry for the service.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* string
A name for the service.
---
### ServiceAssociation
Creates an Association Between a Lattice Service and a Service Network.
#### Initializers
```typescript
import { ServiceAssociation } from 'aws-vpclattice-prealpha'
new ServiceAssociation(scope: Construct, id: string, props: ServiceAssociationProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | ServiceAssociationProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* ServiceAssociationProps
---
#### 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 { ServiceAssociation } from 'aws-vpclattice-prealpha'
ServiceAssociation.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { ServiceAssociation } from 'aws-vpclattice-prealpha'
ServiceAssociation.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `isResource`
```typescript
import { ServiceAssociation } from 'aws-vpclattice-prealpha'
ServiceAssociation.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.
---
### ServiceNetwork
- *Implements:* IServiceNetwork
Create a vpcLattice Service Network.
#### Initializers
```typescript
import { ServiceNetwork } from 'aws-vpclattice-prealpha'
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. |
| addService | Add A lattice service to a lattice network. |
| addStatementToAuthPolicy | This will give the principals access to all resources that are on this service network. |
| applyAuthPolicyToServiceNetwork | Apply the AuthPolicy to a Service Network. |
| associateVPC | Associate a VPC with the Service Network This provides an opinionated default of adding a security group to allow inbound 443. |
| share | Share the The Service network using RAM. |
---
##### `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(props: AddloggingDestinationProps): void
```
send logs to a destination.
###### `props`Required
- *Type:* AddloggingDestinationProps
---
##### `addService`
```typescript
public addService(props: AddServiceProps): void
```
Add A lattice service to a lattice network.
###### `props`Required
- *Type:* AddServiceProps
---
##### `addStatementToAuthPolicy`
```typescript
public addStatementToAuthPolicy(statement: PolicyStatement): void
```
This will give the principals access to all resources that are on this service network.
This is a broad permission.
Consider granting Access at the Service
addToResourcePolicy()
###### `statement`Required
- *Type:* aws-cdk-lib.aws_iam.PolicyStatement
---
##### `applyAuthPolicyToServiceNetwork`
```typescript
public applyAuthPolicyToServiceNetwork(): void
```
Apply the AuthPolicy to a Service Network.
##### `associateVPC`
```typescript
public associateVPC(props: AssociateVPCProps): void
```
Associate a VPC with the Service Network This provides an opinionated default of adding a security group to allow inbound 443.
###### `props`Required
- *Type:* AssociateVPCProps
---
##### `share`
```typescript
public share(props: ShareServiceNetworkProps): void
```
Share the The Service network using RAM.
###### `props`Required
- *Type:* ShareServiceNetworkProps
ShareServiceNetwork.
---
#### 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. |
| fromId | Import a Service Network by Id. |
| fromName | *No description.* |
---
##### ~~`isConstruct`~~
```typescript
import { ServiceNetwork } from 'aws-vpclattice-prealpha'
ServiceNetwork.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { ServiceNetwork } from 'aws-vpclattice-prealpha'
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 'aws-vpclattice-prealpha'
ServiceNetwork.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `fromId`
```typescript
import { ServiceNetwork } from 'aws-vpclattice-prealpha'
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
---
##### `fromName`
```typescript
import { ServiceNetwork } from 'aws-vpclattice-prealpha'
ServiceNetwork.fromName(scope: Construct, id: string, serviceNetworkName: string)
```
###### `scope`Required
- *Type:* constructs.Construct
---
###### `id`Required
- *Type:* string
---
###### `serviceNetworkName`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. |
| imported | boolean | imported. |
| name | string | Name of the ServiceNetwork. |
| serviceNetworkArn | string | The Arn of the service network. |
| serviceNetworkId | string | The Id of the Service Network. |
| authPolicy | aws-cdk-lib.aws_iam.PolicyDocument | A managed Policy that is the auth policy. |
| authType | AuthType | the authType 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.
---
##### `imported`Required
```typescript
public readonly imported: boolean;
```
- *Type:* boolean
imported.
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
Name of the ServiceNetwork.
---
##### `serviceNetworkArn`Required
```typescript
public readonly serviceNetworkArn: string;
```
- *Type:* string
The Arn of the service network.
---
##### `serviceNetworkId`Required
```typescript
public readonly serviceNetworkId: string;
```
- *Type:* string
The Id of the Service Network.
---
##### `authPolicy`Required
```typescript
public readonly authPolicy: PolicyDocument;
```
- *Type:* aws-cdk-lib.aws_iam.PolicyDocument
A managed Policy that is the auth policy.
---
##### `authType`Optional
```typescript
public readonly authType: AuthType;
```
- *Type:* AuthType
the authType of the service network.
---
### ServiceNetworkAssociation
Creates an Association Between a Lattice Service and a Service Network consider using .associateWithServiceNetwork.
#### Initializers
```typescript
import { ServiceNetworkAssociation } from 'aws-vpclattice-prealpha'
new ServiceNetworkAssociation(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 { ServiceNetworkAssociation } from 'aws-vpclattice-prealpha'
ServiceNetworkAssociation.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { ServiceNetworkAssociation } from 'aws-vpclattice-prealpha'
ServiceNetworkAssociation.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `isResource`
```typescript
import { ServiceNetworkAssociation } from 'aws-vpclattice-prealpha'
ServiceNetworkAssociation.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.
---
### TargetGroup
- *Implements:* ITargetGroup
Create a vpc lattice TargetGroup.
#### Initializers
```typescript
import { TargetGroup } from 'aws-vpclattice-prealpha'
new TargetGroup(scope: Construct, id: string, props: TargetGroupProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | TargetGroupProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* TargetGroupProps
---
#### 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 { TargetGroup } from 'aws-vpclattice-prealpha'
TargetGroup.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { TargetGroup } from 'aws-vpclattice-prealpha'
TargetGroup.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `isResource`
```typescript
import { TargetGroup } from 'aws-vpclattice-prealpha'
TargetGroup.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. |
| targetGroupArn | string | The Arn of the targetGroup. |
| 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 targetGroup.
---
##### `targetGroupId`Required
```typescript
public readonly targetGroupId: string;
```
- *Type:* string
The id of the target group.
---
## Structs
### AddloggingDestinationProps
Properties to add a logging Destination.
#### Initializer
```typescript
import { AddloggingDestinationProps } from 'aws-vpclattice-prealpha'
const addloggingDestinationProps: AddloggingDestinationProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| destination | LoggingDestination | The logging destination. |
---
##### `destination`Required
```typescript
public readonly destination: LoggingDestination;
```
- *Type:* LoggingDestination
The logging destination.
---
### AddServiceProps
Properties to add a Service to a Service Network.
#### Initializer
```typescript
import { AddServiceProps } from 'aws-vpclattice-prealpha'
const addServiceProps: AddServiceProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| service | IService | The Service to add to the Service Network. |
| serviceNetworkId | string | The Service Network to add the Service to. |
---
##### `service`Required
```typescript
public readonly service: IService;
```
- *Type:* IService
The Service to add to the Service Network.
---
##### `serviceNetworkId`Required
```typescript
public readonly serviceNetworkId: string;
```
- *Type:* string
The Service Network to add the Service to.
---
### AssociateVpcProps
Props to Associate a VPC with a Service Network.
#### Initializer
```typescript
import { AssociateVpcProps } from 'aws-vpclattice-prealpha'
const associateVpcProps: AssociateVpcProps = { ... }
```
#### 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[]
- *Default:* a security group that will permit inbound 443
security groups for the lattice endpoint.
---
### AssociateVPCProps
Properties to associate a VPC with a Service Network.
#### Initializer
```typescript
import { AssociateVPCProps } from 'aws-vpclattice-prealpha'
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.
---
### DefaultListenerAction
A default listener action.
one of fixed response or forward needs to be provided.
#### Initializer
```typescript
import { DefaultListenerAction } from 'aws-vpclattice-prealpha'
const defaultListenerAction: DefaultListenerAction = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| fixedResponse | FixedResponse | Provide a fixed Response. |
| forward | WeightedTargetGroup | Forward to a target group. |
---
##### `fixedResponse`Optional
```typescript
public readonly fixedResponse: FixedResponse;
```
- *Type:* FixedResponse
- *Default:* none
Provide a fixed Response.
---
##### `forward`Optional
```typescript
public readonly forward: WeightedTargetGroup;
```
- *Type:* WeightedTargetGroup
- *Default:* none
Forward to a target group.
---
### HeaderMatch
Header Matches for creating rules.
#### Initializer
```typescript
import { HeaderMatch } from 'aws-vpclattice-prealpha'
const headerMatch: HeaderMatch = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| headername | string | the name of the header to match. |
| matchOperator | MatchOperator | Type of match to make. |
| matchValue | string | Value to match against. |
| caseSensitive | boolean | Should the match be case sensitive? |
---
##### `headername`Required
```typescript
public readonly headername: string;
```
- *Type:* string
the name of the header to match.
---
##### `matchOperator`Required
```typescript
public readonly matchOperator: MatchOperator;
```
- *Type:* MatchOperator
Type of match to make.
---
##### `matchValue`Required
```typescript
public readonly matchValue: string;
```
- *Type:* string
Value to match against.
---
##### `caseSensitive`Optional
```typescript
public readonly caseSensitive: boolean;
```
- *Type:* boolean
- *Default:* true
Should the match be case sensitive?
---
### HTTPMatch
An HTTPMatch for creating rules At least one of headermatch, method or patchmatches must be created.
#### Initializer
```typescript
import { HTTPMatch } from 'aws-vpclattice-prealpha'
const hTTPMatch: HTTPMatch = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| headerMatches | HeaderMatch[] | Properties to Create A HeaderMatch. |
| method | HTTPMethods | Method to match against. |
| pathMatches | PathMatch | Properties to Create A PathMatch. |
---
##### `headerMatches`Optional
```typescript
public readonly headerMatches: HeaderMatch[];
```
- *Type:* HeaderMatch[]
- *Default:* no header match
Properties to Create A HeaderMatch.
---
##### `method`Optional
```typescript
public readonly method: HTTPMethods;
```
- *Type:* HTTPMethods
- *Default:* no header match
Method to match against.
---
##### `pathMatches`Optional
```typescript
public readonly pathMatches: PathMatch;
```
- *Type:* PathMatch
- *Default:* no path match
Properties to Create A PathMatch.
---
### ImportedServiceNetworkProps
Props for ImportedSearch.
#### Initializer
```typescript
import { ImportedServiceNetworkProps } from 'aws-vpclattice-prealpha'
const importedServiceNetworkProps: ImportedServiceNetworkProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| serviceNetworkId | string | Import by Id. |
| serviceNetworkName | string | Import by Name. |
---
##### `serviceNetworkId`Optional
```typescript
public readonly serviceNetworkId: string;
```
- *Type:* string
- *Default:* No Search by Id
Import by Id.
---
##### `serviceNetworkName`Optional
```typescript
public readonly serviceNetworkName: string;
```
- *Type:* string
- *Default:* No search By Name
Import by Name.
---
### ListenerProps
Propertys to Create a Lattice Listener.
#### Initializer
```typescript
import { ListenerProps } from 'aws-vpclattice-prealpha'
const listenerProps: ListenerProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| service | IService | The Id of the service that this listener is associated with. |
| defaultAction | DefaultListenerAction | * A default action that will be taken if no rules match. |
| name | string | The Name of the service. |
| port | number | Optional port number for the listener. |
| protocol | Protocol | protocol that the listener will listen on. |
| rules | RuleProp[] | rules for the listener. |
---
##### `service`Required
```typescript
public readonly service: IService;
```
- *Type:* IService
The Id of the service that this listener is associated with.
---
##### `defaultAction`Optional
```typescript
public readonly defaultAction: DefaultListenerAction;
```
- *Type:* DefaultListenerAction
- *Default:* 404 NOT Found
* A default action that will be taken if no rules match.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* string
- *Default:* CloudFormation provided name.
The Name of the service.
---
##### `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: Protocol;
```
- *Type:* Protocol
- *Default:* HTTPS
protocol that the listener will listen on.
---
##### `rules`Optional
```typescript
public readonly rules: RuleProp[];
```
- *Type:* RuleProp[]
rules for the listener.
---
### PathMatch
Properties to create a PathMatch.
#### Initializer
```typescript
import { PathMatch } from 'aws-vpclattice-prealpha'
const pathMatch: PathMatch = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| path | string | Value to match against. |
| caseSensitive | boolean | Should the match be case sensitive? |
| pathMatchType | PathMatchType | Type of match to make. |
---
##### `path`Required
```typescript
public readonly path: string;
```
- *Type:* string
Value to match against.
---
##### `caseSensitive`Optional
```typescript
public readonly caseSensitive: boolean;
```
- *Type:* boolean
- *Default:* true
Should the match be case sensitive?
---
##### `pathMatchType`Optional
```typescript
public readonly pathMatchType: PathMatchType;
```
- *Type:* PathMatchType
- *Default:* PathMatchType.EXACT
Type of match to make.
---
### RuleProp
Properties to add rules to to a listener One of headerMatch, PathMatch, or methodMatch can be supplied, the Rule can not match multiple Types.
#### Initializer
```typescript
import { RuleProp } from 'aws-vpclattice-prealpha'
const ruleProp: RuleProp = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| action | FixedResponse \| WeightedTargetGroup[] | the action for the rule, is either a fixed Reponse, or a being sent to Weighted TargetGroup. |
| httpMatch | HTTPMatch | the Matching criteria for the rule. |
| name | string | A name for the the Rule. |
| accessMode | RuleAccessMode | Set an access mode. |
| allowedPrincipalArn | string[] | List of principalArns that are allowed to access the resource. |
| allowedPrincipals | aws-cdk-lib.aws_iam.IPrincipal[] | List of principals that are allowed to access the resource. |
| priority | number | the priority of this rule, a lower priority will be processed first. |
---
##### `action`Required
```typescript
public readonly action: FixedResponse | WeightedTargetGroup[];
```
- *Type:* FixedResponse | WeightedTargetGroup[]
the action for the rule, is either a fixed Reponse, or a being sent to Weighted TargetGroup.
---
##### `httpMatch`Required
```typescript
public readonly httpMatch: HTTPMatch;
```
- *Type:* HTTPMatch
the Matching criteria for the rule.
This must contain at least one of
header, method or patchMatches
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
A name for the the Rule.
---
##### `accessMode`Optional
```typescript
public readonly accessMode: RuleAccessMode;
```
- *Type:* RuleAccessMode
- *Default:* false
Set an access mode.
---
##### `allowedPrincipalArn`Optional
```typescript
public readonly allowedPrincipalArn: string[];
```
- *Type:* string[]
- *Default:* none
List of principalArns that are allowed to access the resource.
---
##### `allowedPrincipals`Optional
```typescript
public readonly allowedPrincipals: IPrincipal[];
```
- *Type:* aws-cdk-lib.aws_iam.IPrincipal[]
- *Default:* none
List of principals that are allowed to access the resource.
---
##### `priority`Optional
```typescript
public readonly priority: number;
```
- *Type:* number
- *Default:* 50
the priority of this rule, a lower priority will be processed first.
---
### ServiceAssociationProps
Props for Service Assocaition.
#### Initializer
```typescript
import { ServiceAssociationProps } from 'aws-vpclattice-prealpha'
const serviceAssociationProps: ServiceAssociationProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| service | IService | lattice Service. |
| serviceNetworkId | string | Lattice ServiceId. |
---
##### `service`Required
```typescript
public readonly service: IService;
```
- *Type:* IService
lattice Service.
---
##### `serviceNetworkId`Required
```typescript
public readonly serviceNetworkId: string;
```
- *Type:* string
Lattice ServiceId.
---
### ServiceNetworkAssociationProps
Props for Service Assocaition.
#### Initializer
```typescript
import { ServiceNetworkAssociationProps } from 'aws-vpclattice-prealpha'
const serviceNetworkAssociationProps: ServiceNetworkAssociationProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| serviceId | string | Lattice ServiceId. |
| serviceNetwork | IServiceNetwork | lattice Service. |
---
##### `serviceId`Required
```typescript
public readonly serviceId: string;
```
- *Type:* string
Lattice ServiceId.
---
##### `serviceNetwork`Required
```typescript
public readonly serviceNetwork: IServiceNetwork;
```
- *Type:* IServiceNetwork
lattice Service.
---
### ServiceNetworkProps
The properties for the ServiceNetwork.
#### Initializer
```typescript
import { ServiceNetworkProps } from 'aws-vpclattice-prealpha'
const serviceNetworkProps: ServiceNetworkProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| accessmode | ServiceNetworkAccessMode | Allow external principals. |
| authStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional AuthStatments:. |
| authType | AuthType | The type of authentication to use with the Service Network. |
| loggingDestinations | LoggingDestination[] | Logging destinations. |
| name | string | The name of the Service Network. |
| services | IService[] | Lattice Services that are assocaited with this Service Network. |
| vpcs | aws-cdk-lib.aws_ec2.IVpc[] | Vpcs that are associated with this Service Network. |
---
##### `accessmode`Optional
```typescript
public readonly accessmode: ServiceNetworkAccessMode;
```
- *Type:* ServiceNetworkAccessMode
- *Default:* false
Allow external principals.
---
##### `authStatements`Optional
```typescript
public readonly authStatements: PolicyStatement[];
```
- *Type:* aws-cdk-lib.aws_iam.PolicyStatement[]
Additional AuthStatments:.
---
##### `authType`Optional
```typescript
public readonly authType: AuthType;
```
- *Type:* AuthType
- *Default:* 'AWS_IAM'
The type of authentication to use with the Service Network.
---
##### `loggingDestinations`Optional
```typescript
public readonly loggingDestinations: LoggingDestination[];
```
- *Type:* LoggingDestination[]
- *Default:* : no logging
Logging destinations.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* string
- *Default:* cloudformation generated name
The name of the Service Network.
If not provided Cloudformation will provide
a name
---
##### `services`Optional
```typescript
public readonly services: IService[];
```
- *Type:* IService[]
- *Default:* no services are associated with the service network
Lattice Services that are assocaited with this Service Network.
---
##### `vpcs`Optional
```typescript
public readonly vpcs: IVpc[];
```
- *Type:* aws-cdk-lib.aws_ec2.IVpc[]
- *Default:* no vpcs are associated
Vpcs that are associated with this Service Network.
---
### ServiceProps
Properties for a Lattice Service.
#### Initializer
```typescript
import { ServiceProps } from 'aws-vpclattice-prealpha'
const serviceProps: ServiceProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authType | string | The authType of the Service. |
| certificate | aws-cdk-lib.aws_certificatemanager.Certificate | A certificate that may be used by the service. |
| customDomain | string | A customDomain used by the service. |
| hostedZone | aws-cdk-lib.aws_route53.IHostedZone | A custom hosname. |
| listeners | IListener[] | Listeners that will be attached to the service. |
| name | string | Name for the service. |
| serviceNetwork | IServiceNetwork | ServiceNetwork to associate with. |
| shares | ShareServiceProps[] | Share Service. |
---
##### `authType`Optional
```typescript
public readonly authType: string;
```
- *Type:* string
- *Default:* 'AWS_IAM'
The authType of the Service.
---
##### `certificate`Optional
```typescript
public readonly certificate: Certificate;
```
- *Type:* aws-cdk-lib.aws_certificatemanager.Certificate
- *Default:* no custom certificate is used
A certificate that may be used by the service.
---
##### `customDomain`Optional
```typescript
public readonly customDomain: string;
```
- *Type:* string
- *Default:* no customdomain is used
A customDomain used by the service.
---
##### `hostedZone`Optional
```typescript
public readonly hostedZone: IHostedZone;
```
- *Type:* aws-cdk-lib.aws_route53.IHostedZone
- *Default:* no hostname is used
A custom hosname.
---
##### `listeners`Optional
```typescript
public readonly listeners: IListener[];
```
- *Type:* IListener[]
- *Default:* no listeners
Listeners that will be attached to the service.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* string
- *Default:* cloudformation will provide a name
Name for the service.
---
##### `serviceNetwork`Optional
```typescript
public readonly serviceNetwork: IServiceNetwork;
```
- *Type:* IServiceNetwork
- *Default:* will not assocaite with any serviceNetwork.
ServiceNetwork to associate with.
---
##### `shares`Optional
```typescript
public readonly shares: ShareServiceProps[];
```
- *Type:* ShareServiceProps[]
- *Default:* no sharing of the service
Share Service.
---
### ShareServiceNetworkProps
Properties to share a Service Network.
#### Initializer
```typescript
import { ShareServiceNetworkProps } from 'aws-vpclattice-prealpha'
const shareServiceNetworkProps: ShareServiceNetworkProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| accounts | string[] | Principals to share the Service Network with. |
| name | string | The name of the share. |
| accessMode | ServiceNetworkAccessMode | The access mode for the Service Network. |
| allowExternalPrincipals | boolean | Are external Principals allowed. |
| description | string | The description of the Service Network. |
| disableDiscovery | boolean | disable discovery. |
| tags | {[ key: string ]: string} | The tags to apply to the Service Network. |
---
##### `accounts`Required
```typescript
public readonly accounts: string[];
```
- *Type:* string[]
- *Default:* none
Principals to share the Service Network with.
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
The name of the share.
---
##### `accessMode`Optional
```typescript
public readonly accessMode: ServiceNetworkAccessMode;
```
- *Type:* ServiceNetworkAccessMode
- *Default:* 'UNAUTHENTICATED'
The access mode for the Service Network.
---
##### `allowExternalPrincipals`Optional
```typescript
public readonly allowExternalPrincipals: boolean;
```
- *Type:* boolean
- *Default:* false;
Are external Principals allowed.
---
##### `description`Optional
```typescript
public readonly description: string;
```
- *Type:* string
- *Default:* none
The description of the Service Network.
---
##### `disableDiscovery`Optional
```typescript
public readonly disableDiscovery: boolean;
```
- *Type:* boolean
- *Default:* false
disable discovery.
---
##### `tags`Optional
```typescript
public readonly tags: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* none
The tags to apply to the Service Network.
---
### ShareServiceProps
Properties to Share the Service.
#### Initializer
```typescript
import { ShareServiceProps } from 'aws-vpclattice-prealpha'
const shareServiceProps: ShareServiceProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | string | The name of the service. |
| accounts | string[] | Principals to share the service with. |
| allowExternalPrincipals | boolean | Allow External Principals. |
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
The name of the service.
---
##### `accounts`Optional
```typescript
public readonly accounts: string[];
```
- *Type:* string[]
- *Default:* none
Principals to share the service with.
TO DO, this needs some work
---
##### `allowExternalPrincipals`Optional
```typescript
public readonly allowExternalPrincipals: boolean;
```
- *Type:* boolean
- *Default:* false
Allow External Principals.
---
### TargetGroupProps
Properties for a Target Group, Only supply one of instancetargets, lambdaTargets, albTargets, ipTargets.
#### Initializer
```typescript
import { TargetGroupProps } from 'aws-vpclattice-prealpha'
const targetGroupProps: TargetGroupProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | string | The name of the target group. |
| target | ITarget | Targets. |
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
The name of the target group.
---
##### `target`Required
```typescript
public readonly target: ITarget;
```
- *Type:* ITarget
Targets.
---
### WeightedTargetGroup
#### Initializer
```typescript
import { WeightedTargetGroup } from 'aws-vpclattice-prealpha'
const weightedTargetGroup: WeightedTargetGroup = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| targetGroup | TargetGroup | A target Group. |
| weight | number | A weight for the target group. |
---
##### `targetGroup`Required
```typescript
public readonly targetGroup: TargetGroup;
```
- *Type:* TargetGroup
A target Group.
---
##### `weight`Optional
```typescript
public readonly weight: number;
```
- *Type:* number
- *Default:* 100
A weight for the target group.
---
## Classes
### LoggingDestination
Logging options.
#### Initializers
```typescript
import { LoggingDestination } from 'aws-vpclattice-prealpha'
new LoggingDestination()
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| cloudwatch | Send to CLoudwatch. |
| kinesis | Stream to Kinesis. |
| s3 | Construct a logging destination for a S3 Bucket. |
---
##### `cloudwatch`
```typescript
import { LoggingDestination } from 'aws-vpclattice-prealpha'
LoggingDestination.cloudwatch(logGroup: ILogGroup)
```
Send to CLoudwatch.
###### `logGroup`Required
- *Type:* aws-cdk-lib.aws_logs.ILogGroup
---
##### `kinesis`
```typescript
import { LoggingDestination } from 'aws-vpclattice-prealpha'
LoggingDestination.kinesis(stream: IStream)
```
Stream to Kinesis.
###### `stream`Required
- *Type:* aws-cdk-lib.aws_kinesis.IStream
---
##### `s3`
```typescript
import { LoggingDestination } from 'aws-vpclattice-prealpha'
LoggingDestination.s3(bucket: IBucket)
```
Construct a logging destination for a S3 Bucket.
###### `bucket`Required
- *Type:* aws-cdk-lib.aws_s3.IBucket
an s3 bucket.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| addr | string | unique addr of the destination. |
| arn | string | An Arn 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.
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
A name of the destination.
---
## Protocols
### IListener
- *Extends:* aws-cdk-lib.IResource
- *Implemented By:* Listener, IListener
Create a vpcLattice Listener.
Implemented by `Listener`.
#### Methods
| **Name** | **Description** |
| --- | --- |
| addListenerRule | Add A Listener Rule to the Listener. |
---
##### `addListenerRule`
```typescript
public addListenerRule(props: RuleProp): void
```
Add A Listener Rule to the Listener.
###### `props`Required
- *Type:* RuleProp
---
#### 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.
---
### IService
- *Extends:* aws-cdk-lib.IResource
- *Implemented By:* Service, IService
Create a vpcLattice service network.
Implemented by `Service`.
#### Methods
| **Name** | **Description** |
| --- | --- |
| applyAuthPolicy | apply an authpolicy to the servicenetwork. |
| associateWithServiceNetwork | associate the service with a servicenetwork. |
---
##### `applyAuthPolicy`
```typescript
public applyAuthPolicy(): PolicyDocument
```
apply an authpolicy to the servicenetwork.
##### `associateWithServiceNetwork`
```typescript
public associateWithServiceNetwork(serviceNetwork: IServiceNetwork): void
```
associate the service with a servicenetwork.
###### `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. |
| imported | boolean | Imported. |
| serviceArn | string | The Arn of the Service. |
| serviceId | string | The Id of the Service. |
| orgId | string | the discovered OrgId. |
| authPolicy | aws-cdk-lib.aws_iam.PolicyDocument | The auth Policy for the service. |
| authType | string | The authType of the service. |
| certificate | aws-cdk-lib.aws_certificatemanager.Certificate | A certificate that may be used by the service. |
| customDomain | string | A custom Domain used by the service. |
| name | string | A name for 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.
---
##### `imported`Required
```typescript
public readonly imported: boolean;
```
- *Type:* boolean
Imported.
---
##### `serviceArn`Required
```typescript
public readonly serviceArn: string;
```
- *Type:* string
The Arn of the Service.
---
##### `serviceId`Required
```typescript
public readonly serviceId: string;
```
- *Type:* string
The Id of the Service.
---
##### `orgId`Optional
```typescript
public readonly orgId: string;
```
- *Type:* string
the discovered OrgId.
---
##### `authPolicy`Required
```typescript
public readonly authPolicy: PolicyDocument;
```
- *Type:* aws-cdk-lib.aws_iam.PolicyDocument
The auth Policy for the service.
---
##### `authType`Optional
```typescript
public readonly authType: string;
```
- *Type:* string
The authType of the service.
---
##### `certificate`Optional
```typescript
public readonly certificate: Certificate;
```
- *Type:* aws-cdk-lib.aws_certificatemanager.Certificate
A certificate that may be used by the service.
---
##### `customDomain`Optional
```typescript
public readonly customDomain: string;
```
- *Type:* string
A custom Domain used by the service.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* string
A name for the service.
---
### IServiceNetwork
- *Extends:* aws-cdk-lib.IResource
- *Implemented By:* ServiceNetwork, IServiceNetwork
Create a vpc lattice service network.
Implemented by `ServiceNetwork`.
#### Methods
| **Name** | **Description** |
| --- | --- |
| addService | Add Lattice Service. |
| associateVPC | Associate a VPC with the Service Network. |
---
##### `addService`
```typescript
public addService(props: AddServiceProps): void
```
Add Lattice Service.
###### `props`Required
- *Type:* AddServiceProps
---
##### `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. |
| imported | boolean | Is this an imported serviceNetwork. |
| 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.
---
##### `imported`Required
```typescript
public readonly imported: boolean;
```
- *Type:* boolean
Is this an imported serviceNetwork.
---
##### `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.
---
### ITarget
- *Implemented By:* ITarget
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| targets | aws-cdk-lib.aws_vpclattice.CfnTargetGroup.TargetProperty[] | References to the targets, ids or Arns. |
| type | string | Target Type. |
| config | aws-cdk-lib.aws_vpclattice.CfnTargetGroup.TargetGroupConfigProperty | Configuration for the TargetGroup, if it is not a lambda. |
---
##### `targets`Required
```typescript
public readonly targets: TargetProperty[];
```
- *Type:* aws-cdk-lib.aws_vpclattice.CfnTargetGroup.TargetProperty[]
References to the targets, ids or Arns.
---
##### `type`Required
```typescript
public readonly type: string;
```
- *Type:* string
Target Type.
---
##### `config`Optional
```typescript
public readonly config: TargetGroupConfigProperty;
```
- *Type:* aws-cdk-lib.aws_vpclattice.CfnTargetGroup.TargetGroupConfigProperty
Configuration for the TargetGroup, if it is not a lambda.
---
### ITargetGroup
- *Extends:* aws-cdk-lib.IResource
- *Implemented By:* TargetGroup, 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
AuthTypes.
#### Members
| **Name** | **Description** |
| --- | --- |
| NONE | No Authorization. |
| AWS_IAM | Use IAM Policy as. |
---
##### `NONE`
No Authorization.
---
##### `AWS_IAM`
Use IAM Policy as.
---
### FixedResponse
Fixed response codes.
#### Members
| **Name** | **Description** |
| --- | --- |
| NOT_FOUND | Not Found 404. |
| OK | OK 200. |
---
##### `NOT_FOUND`
Not Found 404.
---
##### `OK`
OK 200.
---
### HTTPMethods
HTTP Methods.
#### Members
| **Name** | **Description** |
| --- | --- |
| GET | GET Method. |
| POST | POST Method. |
| PUT | PUT Method. |
| DELETE | Delete Method. |
---
##### `GET`
GET Method.
---
##### `POST`
POST Method.
---
##### `PUT`
PUT Method.
---
##### `DELETE`
Delete Method.
---
### MatchOperator
Operators for Matches.
#### Members
| **Name** | **Description** |
| --- | --- |
| CONTAINS | Contains Match. |
| EXACT | Exact Match. |
| PREFIX | Prefix Match. |
---
##### `CONTAINS`
Contains Match.
---
##### `EXACT`
Exact Match.
---
##### `PREFIX`
Prefix Match.
---
### PathMatchType
Operators for Path Matches.
#### Members
| **Name** | **Description** |
| --- | --- |
| EXACT | Exact Match. |
| PREFIX | Prefix Match. |
---
##### `EXACT`
Exact Match.
---
##### `PREFIX`
Prefix Match.
---
### Protocol
HTTP/HTTPS methods.
#### Members
| **Name** | **Description** |
| --- | --- |
| HTTP | HTTP Protocol. |
| HTTPS | HTTPS Protocol. |
---
##### `HTTP`
HTTP Protocol.
---
##### `HTTPS`
HTTPS Protocol.
---
### RuleAccessMode
Access mode for the rule.
#### Members
| **Name** | **Description** |
| --- | --- |
| UNAUTHENTICATED | Unauthenticated Access. |
| AUTHENTICATED_ONLY | Unauthenticated Access. |
| ORG_ONLY | THIS Org only. |
| NO_STATEMENT | Do not create a s. |
---
##### `UNAUTHENTICATED`
Unauthenticated Access.
---
##### `AUTHENTICATED_ONLY`
Unauthenticated Access.
---
##### `ORG_ONLY`
THIS Org only.
---
##### `NO_STATEMENT`
Do not create a s.
---
### ServiceNetworkAccessMode
AccesModes.
#### Members
| **Name** | **Description** |
| --- | --- |
| UNAUTHENTICATED | Unauthenticated Access. |
| AUTHENTICATED_ONLY | Unauthenticated Access. |
| ORG_ONLY | THIS Org only. |
---
##### `UNAUTHENTICATED`
Unauthenticated Access.
---
##### `AUTHENTICATED_ONLY`
Unauthenticated Access.
---
##### `ORG_ONLY`
THIS Org only.
---