Skip to content

Latest commit

 

History

History
174 lines (90 loc) · 6.68 KB

API.md

File metadata and controls

174 lines (90 loc) · 6.68 KB
Raw

API Reference

Classes

Name Description
DockerImageName No description
ECRDeployment No description
S3ArchiveName No description

Structs

Name Description
ECRDeploymentProps No description

Interfaces

Name Description
IImageName No description

class DockerImageName

Implements: IImageName

Initializer

new DockerImageName(name: string, creds?: string)
  • name (string) No description
  • creds (string) The credentials of the docker image.

Properties

Name Type Description
uri string The uri of the docker image.
creds? string The credentials of the docker image.
Optional

class ECRDeployment

Implements: IConstruct, IDependable Extends: Construct

Initializer

new ECRDeployment(scope: Construct, id: string, props: ECRDeploymentProps)
  • scope (Construct) No description
  • id (string) No description
  • props (ECRDeploymentProps) No description
    • dest (IImageName) The destination of the docker image.
    • src (IImageName) The source of the docker image.
    • architecture (string) The architecture of the images to copy. Necessary if the image architecture differs from the lambda architecture.
    • buildImage (string) Image to use to build Golang lambda for custom resource, if download fails or is not wanted. Default: public.ecr.aws/sam/build-go1.x:latest
    • environment (Map<string, string>) The environment variable to set. Optional
    • memoryLimit (number) The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket. Default: 512
    • role (aws_iam.IRole) Execution role associated with this function. Default: A role is automatically created
    • securityGroups (Array<aws_ec2.SecurityGroup>) The list of security groups to associate with the Lambda's network interfaces. Default: If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function.
    • vpc (aws_ec2.IVpc) The VPC network to place the deployment lambda handler in. Default: None
    • vpcSubnets (aws_ec2.SubnetSelection) Where in the VPC to place the deployment lambda handler. Default: the Vpc default strategy if not specified

Methods

addToPrincipalPolicy(statement) 

addToPrincipalPolicy(statement: PolicyStatement): AddToPrincipalPolicyResult

Returns:

class S3ArchiveName

Implements: IImageName

Initializer

new S3ArchiveName(p: string, ref?: string, creds?: string)
  • p (string) No description
  • ref (string) No description
  • creds (string) The credentials of the docker image.

Properties

Name Type Description
uri string The uri of the docker image.
creds? string The credentials of the docker image.
Optional

struct ECRDeploymentProps

Name Type Description
dest IImageName The destination of the docker image.
src IImageName The source of the docker image.
architecture string The architecture of the images to copy. Necessary if the image architecture differs from the lambda architecture.
buildImage? string Image to use to build Golang lambda for custom resource, if download fails or is not wanted.
Default: public.ecr.aws/sam/build-go1.x:latest
environment? Map<string, string> The environment variable to set.
Optional
memoryLimit? number The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket.
Default: 512
role? aws_iam.IRole Execution role associated with this function.
Default: A role is automatically created
securityGroups? Array<aws_ec2.SecurityGroup> The list of security groups to associate with the Lambda's network interfaces.
Default: If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function.
vpc? aws_ec2.IVpc The VPC network to place the deployment lambda handler in.
Default: None
vpcSubnets? aws_ec2.SubnetSelection Where in the VPC to place the deployment lambda handler.
Default: the Vpc default strategy if not specified

interface IImageName

Implemented by: DockerImageName, S3ArchiveName

Properties

Name Type Description
uri string The uri of the docker image.
creds? string The credentials of the docker image.
Optional