Documentation
¶
Index ¶
- func NewTriggerFunction_Override(t TriggerFunction, scope constructs.Construct, id *string, ...)
- func NewTrigger_Override(t Trigger, scope constructs.Construct, id *string, props *TriggerProps)
- func TriggerFunction_ClassifyVersionProperty(propertyName *string, locked *bool)
- func TriggerFunction_FromFunctionArn(scope constructs.Construct, id *string, functionArn *string) awslambda.IFunction
- func TriggerFunction_FromFunctionAttributes(scope constructs.Construct, id *string, attrs *awslambda.FunctionAttributes) awslambda.IFunction
- func TriggerFunction_FromFunctionName(scope constructs.Construct, id *string, functionName *string) awslambda.IFunction
- func TriggerFunction_IsConstruct(x interface{}) *bool
- func TriggerFunction_IsOwnedResource(construct constructs.IConstruct) *bool
- func TriggerFunction_IsResource(construct constructs.IConstruct) *bool
- func TriggerFunction_MetricAll(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func TriggerFunction_MetricAllConcurrentExecutions(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func TriggerFunction_MetricAllDuration(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func TriggerFunction_MetricAllErrors(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func TriggerFunction_MetricAllInvocations(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func TriggerFunction_MetricAllThrottles(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func TriggerFunction_MetricAllUnreservedConcurrentExecutions(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
- func Trigger_IsConstruct(x interface{}) *bool
- type ITrigger
- type InvocationType
- type Trigger
- type TriggerFunction
- type TriggerFunctionProps
- type TriggerInvalidation
- type TriggerOptions
- type TriggerProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewTriggerFunction_Override ¶
func NewTriggerFunction_Override(t TriggerFunction, scope constructs.Construct, id *string, props *TriggerFunctionProps)
func NewTrigger_Override ¶
func NewTrigger_Override(t Trigger, scope constructs.Construct, id *string, props *TriggerProps)
func TriggerFunction_ClassifyVersionProperty ¶
Record whether specific properties in the `AWS::Lambda::Function` resource should also be associated to the Version resource.
See 'currentVersion' section in the module README for more details.
func TriggerFunction_FromFunctionArn ¶
func TriggerFunction_FromFunctionArn(scope constructs.Construct, id *string, functionArn *string) awslambda.IFunction
Import a lambda function into the CDK using its ARN.
func TriggerFunction_FromFunctionAttributes ¶
func TriggerFunction_FromFunctionAttributes(scope constructs.Construct, id *string, attrs *awslambda.FunctionAttributes) awslambda.IFunction
Creates a Lambda function object which represents a function not defined within this stack.
func TriggerFunction_FromFunctionName ¶
func TriggerFunction_FromFunctionName(scope constructs.Construct, id *string, functionName *string) awslambda.IFunction
Import a lambda function into the CDK using its name.
func TriggerFunction_IsConstruct ¶
func TriggerFunction_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 TriggerFunction_IsOwnedResource ¶ added in v2.32.0
func TriggerFunction_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func TriggerFunction_IsResource ¶
func TriggerFunction_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func TriggerFunction_MetricAll ¶
func TriggerFunction_MetricAll(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Return the given named metric for this Lambda.
func TriggerFunction_MetricAllConcurrentExecutions ¶
func TriggerFunction_MetricAllConcurrentExecutions(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of concurrent executions across all Lambdas. Default: max over 5 minutes.
func TriggerFunction_MetricAllDuration ¶
func TriggerFunction_MetricAllDuration(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the Duration executing all Lambdas. Default: average over 5 minutes.
func TriggerFunction_MetricAllErrors ¶
func TriggerFunction_MetricAllErrors(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of Errors executing all Lambdas. Default: sum over 5 minutes.
func TriggerFunction_MetricAllInvocations ¶
func TriggerFunction_MetricAllInvocations(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of invocations of all Lambdas. Default: sum over 5 minutes.
func TriggerFunction_MetricAllThrottles ¶
func TriggerFunction_MetricAllThrottles(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of throttled invocations of all Lambdas. Default: sum over 5 minutes.
func TriggerFunction_MetricAllUnreservedConcurrentExecutions ¶
func TriggerFunction_MetricAllUnreservedConcurrentExecutions(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
Metric for the number of unreserved concurrent executions across all Lambdas. Default: max over 5 minutes.
func Trigger_IsConstruct ¶
func Trigger_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`.
Types ¶
type ITrigger ¶
type ITrigger interface {
constructs.IConstruct
// Adds trigger dependencies.
//
// Execute this trigger only after these construct
// scopes have been provisioned.
ExecuteAfter(scopes ...constructs.Construct)
// Adds this trigger as a dependency on other constructs.
//
// This means that this
// trigger will get executed *before* the given construct(s).
ExecuteBefore(scopes ...constructs.Construct)
}
Interface for triggers.
type InvocationType ¶ added in v2.56.0
type InvocationType string
The invocation type to apply to a trigger.
This determines whether the trigger function should await the result of the to be triggered function or not.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
func := lambda.NewFunction(this, jsii.String("MyFunction"), &functionProps{
Handler: jsii.String("index.handler"),
Runtime: lambda.Runtime_NODEJS_14_X(),
Code: lambda.Code_FromInline(jsii.String("foo")),
})
triggers.NewTrigger(this, jsii.String("MyTrigger"), &TriggerProps{
Handler: func,
Timeout: awscdk.Duration_Minutes(jsii.Number(10)),
InvocationType: triggers.InvocationType_EVENT,
})
const ( // Invoke the function asynchronously. // // Send events that fail multiple times to the function's dead-letter queue (if one is configured). // The API response only includes a status code. InvocationType_EVENT InvocationType = "EVENT" // Invoke the function synchronously. // // Keep the connection open until the function returns a response or times out. // The API response includes the function response and additional data. InvocationType_REQUEST_RESPONSE InvocationType = "REQUEST_RESPONSE" // Validate parameter values and verify that the user or role has permission to invoke the function. InvocationType_DRY_RUN InvocationType = "DRY_RUN" )
type Trigger ¶
type Trigger interface {
constructs.Construct
ITrigger
// The tree node.
Node() constructs.Node
// Adds trigger dependencies.
//
// Execute this trigger only after these construct
// scopes have been provisioned.
ExecuteAfter(scopes ...constructs.Construct)
// Adds this trigger as a dependency on other constructs.
//
// This means that this
// trigger will get executed *before* the given construct(s).
ExecuteBefore(scopes ...constructs.Construct)
// Returns a string representation of this construct.
ToString() *string
}
Triggers an AWS Lambda function during deployment.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
func := lambda.NewFunction(this, jsii.String("MyFunction"), &functionProps{
Handler: jsii.String("index.handler"),
Runtime: lambda.Runtime_NODEJS_14_X(),
Code: lambda.Code_FromInline(jsii.String("foo")),
})
triggers.NewTrigger(this, jsii.String("MyTrigger"), &TriggerProps{
Handler: func,
Timeout: awscdk.Duration_Minutes(jsii.Number(10)),
InvocationType: triggers.InvocationType_EVENT,
})
func NewTrigger ¶
func NewTrigger(scope constructs.Construct, id *string, props *TriggerProps) Trigger
type TriggerFunction ¶
type TriggerFunction interface {
awslambda.Function
ITrigger
// The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).
Architecture() awslambda.Architecture
// Whether the addPermission() call adds any permissions.
//
// True for new Lambdas, false for version $LATEST and imported Lambdas
// from different accounts.
CanCreatePermissions() *bool
// Access the Connections object.
//
// Will fail if not a VPC-enabled Lambda Function.
Connections() awsec2.Connections
// Returns a `lambda.Version` which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes.
//
// You can specify options for this version using the `currentVersionOptions`
// prop when initializing the `lambda.Function`.
CurrentVersion() awslambda.Version
// The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).
DeadLetterQueue() awssqs.IQueue
// The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).
DeadLetterTopic() awssns.ITopic
// 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
// ARN of this function.
FunctionArn() *string
// Name of this function.
FunctionName() *string
// The principal this Lambda Function is running as.
GrantPrincipal() awsiam.IPrincipal
// Whether or not this Lambda function was bound to a VPC.
//
// If this is is `false`, trying to access the `connections` object will fail.
IsBoundToVpc() *bool
// The `$LATEST` version of this function.
//
// Note that this is reference to a non-specific AWS Lambda version, which
// means the function this version refers to can return different results in
// different invocations.
//
// To obtain a reference to an explicit version which references the current
// function configuration, use `lambdaFunction.currentVersion` instead.
LatestVersion() awslambda.IVersion
// The LogGroup where the Lambda function's logs are made available.
//
// If either `logRetention` is set or this property is called, a CloudFormation custom resource is added to the stack that
// pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention
// period (never expire, by default).
//
// Further, if the log group already exists and the `logRetention` is not set, the custom resource will reset the log retention
// to never expire even if it was configured with a different value.
LogGroup() awslogs.ILogGroup
// The tree node.
Node() constructs.Node
// The construct node where permissions are attached.
PermissionsNode() 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 ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().
ResourceArnsForGrantInvoke() *[]*string
// Execution role associated with this function.
Role() awsiam.IRole
// The runtime configured for this lambda.
Runtime() awslambda.Runtime
// The stack in which this resource is defined.
Stack() awscdk.Stack
// The timeout configured for this lambda.
Timeout() awscdk.Duration
// The underlying trigger resource.
Trigger() Trigger
// Defines an alias for this function.
//
// The alias will automatically be updated to point to the latest version of
// the function as it is being updated during a deployment.
//
// “`ts
// declare const fn: lambda.Function;
//
// fn.addAlias('Live');
//
// // Is equivalent to
//
// new lambda.Alias(this, 'AliasLive', {
// aliasName: 'Live',
// version: fn.currentVersion,
// });
// “`.
AddAlias(aliasName *string, options *awslambda.AliasOptions) awslambda.Alias
// Adds an environment variable to this Lambda function.
//
// If this is a ref to a Lambda function, this operation results in a no-op.
AddEnvironment(key *string, value *string, options *awslambda.EnvironmentOptions) awslambda.Function
// Adds an event source to this function.
//
// Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module.
//
// The following example adds an SQS Queue as an event source:
// “`
// import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
// myFunction.addEventSource(new SqsEventSource(myQueue));
// “`.
AddEventSource(source awslambda.IEventSource)
// Adds an event source that maps to this AWS Lambda function.
AddEventSourceMapping(id *string, options *awslambda.EventSourceMappingOptions) awslambda.EventSourceMapping
// Adds a url to this lambda function.
AddFunctionUrl(options *awslambda.FunctionUrlOptions) awslambda.FunctionUrl
// Adds one or more Lambda Layers to this Lambda function.
AddLayers(layers ...awslambda.ILayerVersion)
// Adds a permission to the Lambda resource policy.
// See: Permission for details.
//
AddPermission(id *string, permission *awslambda.Permission)
// Adds a statement to the IAM role assumed by the instance.
AddToRolePolicy(statement awsiam.PolicyStatement)
// 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)
// Configures options for asynchronous invocation.
ConfigureAsyncInvoke(options *awslambda.EventInvokeConfigOptions)
// A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function.
//
// - function.currentVersion is invoked before or after the permission is created.
//
// This applies only to permissions on Lambda functions, not versions or aliases.
// This function is overridden as a noOp for QualifiedFunctionBase.
ConsiderWarningOnInvokeFunctionPermissions(scope constructs.Construct, action *string)
// Adds trigger dependencies.
//
// Execute this trigger only after these construct
// scopes have been provisioned.
ExecuteAfter(scopes ...constructs.Construct)
// Adds this trigger as a dependency on other constructs.
//
// This means that this
// trigger will get executed *before* the given construct(s).
ExecuteBefore(scopes ...constructs.Construct)
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
// Grant the given identity permissions to invoke this Lambda.
GrantInvoke(grantee awsiam.IGrantable) awsiam.Grant
// Grant the given identity permissions to invoke this Lambda Function URL.
GrantInvokeUrl(grantee awsiam.IGrantable) awsiam.Grant
// Mix additional information into the hash of the Version object.
//
// The Lambda Function construct does its best to automatically create a new
// Version when anything about the Function changes (its code, its layers,
// any of the other properties).
//
// However, you can sometimes source information from places that the CDK cannot
// look into, like the deploy-time values of SSM parameters. In those cases,
// the CDK would not force the creation of a new Version object when it actually
// should.
//
// This method can be used to invalidate the current Version object. Pass in
// any string into this method, and make sure the string changes when you know
// a new Version needs to be created.
//
// This method may be called more than once.
InvalidateVersionBasedOn(x *string)
// Return the given named metric for this Function.
Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// How long execution of this Lambda takes.
//
// Average over 5 minutes.
MetricDuration(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// How many invocations of this Lambda fail.
//
// Sum over 5 minutes.
MetricErrors(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// How often this Lambda is invoked.
//
// Sum over 5 minutes.
MetricInvocations(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// How often this Lambda is throttled.
//
// Sum over 5 minutes.
MetricThrottles(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
// Returns a string representation of this construct.
ToString() *string
WarnInvokeFunctionPermissions(scope constructs.Construct)
}
Invokes an AWS Lambda function during deployment.
Example:
import triggers "github.com/aws/aws-cdk-go/awscdk"
triggers.NewTriggerFunction(this, jsii.String("MyTrigger"), &TriggerFunctionProps{
Runtime: lambda.Runtime_NODEJS_14_X(),
Handler: jsii.String("index.handler"),
Code: lambda.Code_FromAsset(jsii.String(__dirname + "/my-trigger")),
})
func NewTriggerFunction ¶
func NewTriggerFunction(scope constructs.Construct, id *string, props *TriggerFunctionProps) TriggerFunction
type TriggerFunctionProps ¶
type TriggerFunctionProps struct {
// The maximum age of a request that Lambda sends to a function for processing.
//
// Minimum: 60 seconds
// Maximum: 6 hours.
// Default: Duration.hours(6)
//
MaxEventAge awscdk.Duration `field:"optional" json:"maxEventAge" yaml:"maxEventAge"`
// The destination for failed invocations.
// Default: - no destination.
//
OnFailure awslambda.IDestination `field:"optional" json:"onFailure" yaml:"onFailure"`
// The destination for successful invocations.
// Default: - no destination.
//
OnSuccess awslambda.IDestination `field:"optional" json:"onSuccess" yaml:"onSuccess"`
// The maximum number of times to retry when the function returns an error.
//
// Minimum: 0
// Maximum: 2.
// Default: 2.
//
RetryAttempts *float64 `field:"optional" json:"retryAttempts" yaml:"retryAttempts"`
// Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.
// See: https://aws-otel.github.io/docs/getting-started/lambda
//
// Default: - No ADOT instrumentation.
//
AdotInstrumentation *awslambda.AdotInstrumentationConfig `field:"optional" json:"adotInstrumentation" yaml:"adotInstrumentation"`
// Whether to allow the Lambda to send all network traffic.
//
// If set to false, you must individually add traffic rules to allow the
// Lambda to connect to network targets.
// Default: true.
//
AllowAllOutbound *bool `field:"optional" json:"allowAllOutbound" yaml:"allowAllOutbound"`
// Lambda Functions in a public subnet can NOT access the internet.
//
// Use this property to acknowledge this limitation and still place the function in a public subnet.
// See: https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841
//
// Default: false.
//
AllowPublicSubnet *bool `field:"optional" json:"allowPublicSubnet" yaml:"allowPublicSubnet"`
// The system architectures compatible with this lambda function.
// Default: Architecture.X86_64
//
Architecture awslambda.Architecture `field:"optional" json:"architecture" yaml:"architecture"`
// Code signing config associated with this function.
// Default: - Not Sign the Code.
//
CodeSigningConfig awslambda.ICodeSigningConfig `field:"optional" json:"codeSigningConfig" yaml:"codeSigningConfig"`
// Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method.
// Default: - default options as described in `VersionOptions`.
//
CurrentVersionOptions *awslambda.VersionOptions `field:"optional" json:"currentVersionOptions" yaml:"currentVersionOptions"`
// The SQS queue to use if DLQ is enabled.
//
// If SNS topic is desired, specify `deadLetterTopic` property instead.
// Default: - SQS queue with 14 day retention period if `deadLetterQueueEnabled` is `true`.
//
DeadLetterQueue awssqs.IQueue `field:"optional" json:"deadLetterQueue" yaml:"deadLetterQueue"`
// Enabled DLQ.
//
// If `deadLetterQueue` is undefined,
// an SQS queue with default options will be defined for your Function.
// Default: - false unless `deadLetterQueue` is set, which implies DLQ is enabled.
//
DeadLetterQueueEnabled *bool `field:"optional" json:"deadLetterQueueEnabled" yaml:"deadLetterQueueEnabled"`
// The SNS topic to use as a DLQ.
//
// Note that if `deadLetterQueueEnabled` is set to `true`, an SQS queue will be created
// rather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly.
// Default: - no SNS topic.
//
DeadLetterTopic awssns.ITopic `field:"optional" json:"deadLetterTopic" yaml:"deadLetterTopic"`
// A description of the function.
// Default: - No description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Key-value pairs that Lambda caches and makes available for your Lambda functions.
//
// Use environment variables to apply configuration changes, such
// as test and production environment configurations, without changing your
// Lambda function source code.
// Default: - No environment variables.
//
Environment *map[string]*string `field:"optional" json:"environment" yaml:"environment"`
// The AWS KMS key that's used to encrypt your function's environment variables.
// Default: - AWS Lambda creates and uses an AWS managed customer master key (CMK).
//
EnvironmentEncryption awskms.IKey `field:"optional" json:"environmentEncryption" yaml:"environmentEncryption"`
// The size of the function’s /tmp directory in MiB.
// Default: 512 MiB.
//
EphemeralStorageSize awscdk.Size `field:"optional" json:"ephemeralStorageSize" yaml:"ephemeralStorageSize"`
// Event sources for this function.
//
// You can also add event sources using `addEventSource`.
// Default: - No event sources.
//
Events *[]awslambda.IEventSource `field:"optional" json:"events" yaml:"events"`
// The filesystem configuration for the lambda function.
// Default: - will not mount any filesystem.
//
Filesystem awslambda.FileSystem `field:"optional" json:"filesystem" yaml:"filesystem"`
// A name for the function.
// Default: - AWS CloudFormation generates a unique physical ID and uses that
// ID for the function's name. For more information, see Name Type.
//
FunctionName *string `field:"optional" json:"functionName" yaml:"functionName"`
// Initial policy statements to add to the created Lambda Role.
//
// You can call `addToRolePolicy` to the created lambda to add statements post creation.
// Default: - No policy statements are added to the created Lambda role.
//
InitialPolicy *[]awsiam.PolicyStatement `field:"optional" json:"initialPolicy" yaml:"initialPolicy"`
// Specify the version of CloudWatch Lambda insights to use for monitoring.
// See: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-docker.html
//
// Default: - No Lambda Insights.
//
InsightsVersion awslambda.LambdaInsightsVersion `field:"optional" json:"insightsVersion" yaml:"insightsVersion"`
// A list of layers to add to the function's execution environment.
//
// You can configure your Lambda function to pull in
// additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies
// that can be used by multiple functions.
// Default: - No layers.
//
Layers *[]awslambda.ILayerVersion `field:"optional" json:"layers" yaml:"layers"`
// The number of days log events are kept in CloudWatch Logs.
//
// When updating
// this property, unsetting it doesn't remove the log retention policy. To
// remove the retention policy, set the value to `INFINITE`.
// Default: logs.RetentionDays.INFINITE
//
LogRetention awslogs.RetentionDays `field:"optional" json:"logRetention" yaml:"logRetention"`
// When log retention is specified, a custom resource attempts to create the CloudWatch log group.
//
// These options control the retry policy when interacting with CloudWatch APIs.
// Default: - Default AWS SDK retry options.
//
LogRetentionRetryOptions *awslambda.LogRetentionRetryOptions `field:"optional" json:"logRetentionRetryOptions" yaml:"logRetentionRetryOptions"`
// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
// Default: - A new role is created.
//
LogRetentionRole awsiam.IRole `field:"optional" json:"logRetentionRole" yaml:"logRetentionRole"`
// The amount of memory, in MB, that is allocated to your Lambda function.
//
// Lambda uses this value to proportionally allocate the amount of CPU
// power. For more information, see Resource Model in the AWS Lambda
// Developer Guide.
// Default: 128.
//
MemorySize *float64 `field:"optional" json:"memorySize" yaml:"memorySize"`
// Specify the configuration of Parameters and Secrets Extension.
// See: https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-integration-lambda-extensions.html
//
// Default: - No Parameters and Secrets Extension.
//
ParamsAndSecrets awslambda.ParamsAndSecretsLayerVersion `field:"optional" json:"paramsAndSecrets" yaml:"paramsAndSecrets"`
// Enable profiling.
// See: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html
//
// Default: - No profiling.
//
Profiling *bool `field:"optional" json:"profiling" yaml:"profiling"`
// Profiling Group.
// See: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html
//
// Default: - A new profiling group will be created if `profiling` is set.
//
ProfilingGroup awscodeguruprofiler.IProfilingGroup `field:"optional" json:"profilingGroup" yaml:"profilingGroup"`
// The maximum of concurrent executions you want to reserve for the function.
// See: https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html
//
// Default: - No specific limit - account limit.
//
ReservedConcurrentExecutions *float64 `field:"optional" json:"reservedConcurrentExecutions" yaml:"reservedConcurrentExecutions"`
// Lambda execution role.
//
// This is the role that will be assumed by the function upon execution.
// It controls the permissions that the function will have. The Role must
// be assumable by the 'lambda.amazonaws.com' service principal.
//
// The default Role automatically has permissions granted for Lambda execution. If you
// provide a Role, you must add the relevant AWS managed policies yourself.
//
// The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and
// "service-role/AWSLambdaVPCAccessExecutionRole".
// Default: - A unique role will be generated for this lambda function.
// Both supplied and generated roles can always be changed by calling `addToRolePolicy`.
//
Role awsiam.IRole `field:"optional" json:"role" yaml:"role"`
// Sets the runtime management configuration for a function's version.
// Default: Auto.
//
RuntimeManagementMode awslambda.RuntimeManagementMode `field:"optional" json:"runtimeManagementMode" yaml:"runtimeManagementMode"`
// The list of security groups to associate with the Lambda's network interfaces.
//
// Only used if 'vpc' is supplied.
// 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.
//
SecurityGroups *[]awsec2.ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// The function execution time (in seconds) after which Lambda terminates the function.
//
// Because the execution time affects cost, set this value
// based on the function's expected execution time.
// Default: Duration.seconds(3)
//
Timeout awscdk.Duration `field:"optional" json:"timeout" yaml:"timeout"`
// Enable AWS X-Ray Tracing for Lambda Function.
// Default: Tracing.Disabled
//
Tracing awslambda.Tracing `field:"optional" json:"tracing" yaml:"tracing"`
// VPC network to place Lambda network interfaces.
//
// Specify this if the Lambda function needs to access resources in a VPC.
// This is required when `vpcSubnets` is specified.
// Default: - Function is not placed within a VPC.
//
Vpc awsec2.IVpc `field:"optional" json:"vpc" yaml:"vpc"`
// Where to place the network interfaces within the VPC.
//
// This requires `vpc` to be specified in order for interfaces to actually be
// placed in the subnets. If `vpc` is not specify, this will raise an error.
//
// Note: Internet access for Lambda Functions requires a NAT Gateway, so picking
// public subnets is not allowed (unless `allowPublicSubnet` is set to `true`).
// Default: - the Vpc default strategy if not specified.
//
VpcSubnets *awsec2.SubnetSelection `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"`
// The source code of your Lambda function.
//
// You can point to a file in an
// Amazon Simple Storage Service (Amazon S3) bucket or specify your source
// code as inline text.
Code awslambda.Code `field:"required" json:"code" yaml:"code"`
// The name of the method within your code that Lambda calls to execute your function.
//
// The format includes the file name. It can also include
// namespaces and other qualifiers, depending on the runtime.
// For more information, see https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html.
//
// Use `Handler.FROM_IMAGE` when defining a function from a Docker image.
//
// NOTE: If you specify your source code as inline text by specifying the
// ZipFile property within the Code property, specify index.function_name as
// the handler.
Handler *string `field:"required" json:"handler" yaml:"handler"`
// The runtime environment for the Lambda function that you are uploading.
//
// For valid values, see the Runtime property in the AWS Lambda Developer
// Guide.
//
// Use `Runtime.FROM_IMAGE` when defining a function from a Docker image.
Runtime awslambda.Runtime `field:"required" json:"runtime" yaml:"runtime"`
// Adds trigger dependencies. Execute this trigger only after these construct scopes have been provisioned.
//
// You can also use `trigger.executeAfter()` to add additional dependencies.
// Default: [].
//
ExecuteAfter *[]constructs.Construct `field:"optional" json:"executeAfter" yaml:"executeAfter"`
// Adds this trigger as a dependency on other constructs.
//
// This means that this
// trigger will get executed *before* the given construct(s).
//
// You can also use `trigger.executeBefore()` to add additional dependants.
// Default: [].
//
ExecuteBefore *[]constructs.Construct `field:"optional" json:"executeBefore" yaml:"executeBefore"`
// Re-executes the trigger every time the handler changes.
//
// This implies that the trigger is associated with the `currentVersion` of
// the handler, which gets recreated every time the handler or its
// configuration is updated.
// Default: true.
//
ExecuteOnHandlerChange *bool `field:"optional" json:"executeOnHandlerChange" yaml:"executeOnHandlerChange"`
}
Props for `InvokeFunction`.
Example:
import triggers "github.com/aws/aws-cdk-go/awscdk"
triggers.NewTriggerFunction(this, jsii.String("MyTrigger"), &TriggerFunctionProps{
Runtime: lambda.Runtime_NODEJS_14_X(),
Handler: jsii.String("index.handler"),
Code: lambda.Code_FromAsset(jsii.String(__dirname + "/my-trigger")),
})
type TriggerInvalidation ¶
type TriggerInvalidation string
Determines.
const ( // The trigger will be executed every time the handler (or its configuration) changes. // // This is implemented by associated the trigger with the `currentVersion` // of the AWS Lambda function, which gets recreated every time the handler changes. TriggerInvalidation_HANDLER_CHANGE TriggerInvalidation = "HANDLER_CHANGE" )
type TriggerOptions ¶
type TriggerOptions struct {
// Adds trigger dependencies. Execute this trigger only after these construct scopes have been provisioned.
//
// You can also use `trigger.executeAfter()` to add additional dependencies.
// Default: [].
//
ExecuteAfter *[]constructs.Construct `field:"optional" json:"executeAfter" yaml:"executeAfter"`
// Adds this trigger as a dependency on other constructs.
//
// This means that this
// trigger will get executed *before* the given construct(s).
//
// You can also use `trigger.executeBefore()` to add additional dependants.
// Default: [].
//
ExecuteBefore *[]constructs.Construct `field:"optional" json:"executeBefore" yaml:"executeBefore"`
// Re-executes the trigger every time the handler changes.
//
// This implies that the trigger is associated with the `currentVersion` of
// the handler, which gets recreated every time the handler or its
// configuration is updated.
// Default: true.
//
ExecuteOnHandlerChange *bool `field:"optional" json:"executeOnHandlerChange" yaml:"executeOnHandlerChange"`
}
Options for `Trigger`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import constructs "github.com/aws/constructs-go/constructs"
var construct construct
triggerOptions := &TriggerOptions{
ExecuteAfter: []*construct{
construct,
},
ExecuteBefore: []*construct{
construct,
},
ExecuteOnHandlerChange: jsii.Boolean(false),
}
type TriggerProps ¶
type TriggerProps struct {
// Adds trigger dependencies. Execute this trigger only after these construct scopes have been provisioned.
//
// You can also use `trigger.executeAfter()` to add additional dependencies.
// Default: [].
//
ExecuteAfter *[]constructs.Construct `field:"optional" json:"executeAfter" yaml:"executeAfter"`
// Adds this trigger as a dependency on other constructs.
//
// This means that this
// trigger will get executed *before* the given construct(s).
//
// You can also use `trigger.executeBefore()` to add additional dependants.
// Default: [].
//
ExecuteBefore *[]constructs.Construct `field:"optional" json:"executeBefore" yaml:"executeBefore"`
// Re-executes the trigger every time the handler changes.
//
// This implies that the trigger is associated with the `currentVersion` of
// the handler, which gets recreated every time the handler or its
// configuration is updated.
// Default: true.
//
ExecuteOnHandlerChange *bool `field:"optional" json:"executeOnHandlerChange" yaml:"executeOnHandlerChange"`
// The AWS Lambda function of the handler to execute.
Handler awslambda.Function `field:"required" json:"handler" yaml:"handler"`
// The invocation type to invoke the Lambda function with.
// Default: RequestResponse.
//
InvocationType InvocationType `field:"optional" json:"invocationType" yaml:"invocationType"`
// The timeout of the invocation call of the Lambda function to be triggered.
// Default: Duration.minutes(2)
//
Timeout awscdk.Duration `field:"optional" json:"timeout" yaml:"timeout"`
}
Props for `Trigger`.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
func := lambda.NewFunction(this, jsii.String("MyFunction"), &functionProps{
Handler: jsii.String("index.handler"),
Runtime: lambda.Runtime_NODEJS_14_X(),
Code: lambda.Code_FromInline(jsii.String("foo")),
})
triggers.NewTrigger(this, jsii.String("MyTrigger"), &TriggerProps{
Handler: func,
Timeout: awscdk.Duration_Minutes(jsii.Number(10)),
InvocationType: triggers.InvocationType_EVENT,
})