lambdalayerawscli

README

AWS Lambda Layer with AWS CLI

This module exports a single class called AwsCliLayer which is a lambda.Layer that bundles the AWS CLI.

Any Lambda Function that uses this layer must use a Python 3.x runtime.

Usage:

// AwsCliLayer bundles the AWS CLI in a lambda layer
import "github.com/aws/aws-cdk-go/awscdk"

var fn function

fn.AddLayers(awscdk.NewAwsCliLayer(this, jsii.String("AwsCliLayer")))

The CLI will be installed under /opt/awscli/aws.

Alternatives

This module bundles AWS cli v1. To use AWS cli v2, you can use the external module awscdk-asset-awscli.

Documentation

Index

• func AwsCliLayer_FromLayerVersionArn(scope constructs.Construct, id *string, layerVersionArn *string) awslambda.ILayerVersion
• func AwsCliLayer_FromLayerVersionAttributes(scope constructs.Construct, id *string, ...) awslambda.ILayerVersion
• func AwsCliLayer_IsConstruct(x interface{}) *bool
• func AwsCliLayer_IsOwnedResource(construct constructs.IConstruct) *bool
• func AwsCliLayer_IsResource(construct constructs.IConstruct) *bool
• func NewAwsCliLayer_Override(a AwsCliLayer, scope constructs.Construct, id *string)
• type AwsCliLayer
  • func NewAwsCliLayer(scope constructs.Construct, id *string) AwsCliLayer

Functions

func AwsCliLayer_FromLayerVersionArn

func AwsCliLayer_FromLayerVersionArn(scope constructs.Construct, id *string, layerVersionArn *string) awslambda.ILayerVersion

Imports a layer version by ARN.

Assumes it is compatible with all Lambda runtimes.

func AwsCliLayer_FromLayerVersionAttributes

func AwsCliLayer_FromLayerVersionAttributes(scope constructs.Construct, id *string, attrs *awslambda.LayerVersionAttributes) awslambda.ILayerVersion

Imports a Layer that has been defined externally.

func AwsCliLayer_IsConstruct

func AwsCliLayer_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func AwsCliLayer_IsOwnedResource

func AwsCliLayer_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func AwsCliLayer_IsResource

func AwsCliLayer_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func NewAwsCliLayer_Override

func NewAwsCliLayer_Override(a AwsCliLayer, scope constructs.Construct, id *string)

Types

type AwsCliLayer

type AwsCliLayer interface {
	awslambda.LayerVersion
	// The runtimes compatible with this Layer.
	CompatibleRuntimes() *[]awslambda.Runtime
	// 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.
	Env() *awscdk.ResourceEnvironment
	// The ARN of the Lambda Layer version that this Layer defines.
	LayerVersionArn() *string
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	// Add permission for this layer version to specific entities.
	//
	// Usage within
	// the same account where the layer is defined is always allowed and does not
	// require calling this method. Note that the principal that creates the
	// Lambda function using the layer (for example, a CloudFormation changeset
	// execution role) also needs to have the “lambda:GetLayerVersion“
	// permission on the layer version.
	AddPermission(id *string, permission *awslambda.LayerVersionPermission)
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	ToString() *string
}

An AWS Lambda layer that includes the AWS CLI.

Example:

// AwsCliLayer bundles the AWS CLI in a lambda layer
import "github.com/aws/aws-cdk-go/awscdk"

var fn function

fn.AddLayers(awscdk.NewAwsCliLayer(this, jsii.String("AwsCliLayer")))

func NewAwsCliLayer

func NewAwsCliLayer(scope constructs.Construct, id *string) AwsCliLayer