CfnWebFunctionRevision
- class aws_cdk.aws_lambda.CfnWebFunctionRevision(scope, id, *, build_config, function_name, service_config, description=None, kms_key_arn=None)
Bases:
CfnResourceResource Type definition for AWS::Lambda::WebFunctionRevision.
An immutable revision of a Lambda web function, containing the function code and configuration.
- See:
- CloudformationResource:
AWS::Lambda::WebFunctionRevision
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lambda as lambda_ cfn_web_function_revision = lambda_.CfnWebFunctionRevision(self, "MyCfnWebFunctionRevision", build_config=lambda.CfnWebFunctionRevision.BuildConfigProperty( code_config=lambda.CfnWebFunctionRevision.CodeConfigProperty( s3_object=lambda.CfnWebFunctionRevision.S3ObjectProperty( bucket="bucket", key="key", # the properties below are optional version_id="versionId" ) ), runtime_config=lambda.CfnWebFunctionRevision.RuntimeConfigProperty( runtime="runtime" ) ), function_name="functionName", service_config=lambda.CfnWebFunctionRevision.ServiceConfigProperty( execution_role_arn="executionRoleArn", # the properties below are optional environment_variables={ "environment_variables_key": "environmentVariables" }, max_concurrency_per_environment=123, telemetry_config=lambda.CfnWebFunctionRevision.TelemetryConfigProperty( logging_config=lambda.CfnWebFunctionRevision.LoggingConfigProperty( application_log_level="applicationLogLevel", log_group="logGroup", system_log_level="systemLogLevel" ) ), timeout_seconds=123 ), # the properties below are optional description="description", kms_key_arn="kmsKeyArn" )
Create a new
AWS::Lambda::WebFunctionRevision.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).build_config (
Union[IResolvable,BuildConfigProperty,Dict[str,Any]]) – The build configuration for the revision.function_name (
str) – The name of the web function this revision belongs to. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.service_config (
Union[IResolvable,ServiceConfigProperty,Dict[str,Any]]) – The service configuration for the revision.description (
Optional[str]) – A description of the revision.kms_key_arn (
Optional[str]) – The ARN of the KMS key used to encrypt the revision.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This method has been renamed to
addResourceDependencyto more clearly set it apart fromconstruct.node.addDependency. See the documentation of that function for more details.- Parameters:
target (
CfnResource)- Deprecated:
Use
addResourceDependencyinstead.- Stability:
deprecated
- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to
addResourceDependency, which makes it more clear that this method operates at a different level from the construct-levelconstruct.node.addDependency()mechanism.- Parameters:
target (
CfnResource)- Deprecated:
Use
addResourceDependencyinstead.- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- add_resource_dependency(target, reason=None)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use
construct.node.addDependencyinstead.- Parameters:
target (
CfnResource)reason (
Optional[str])
- Return type:
None
- apply_cross_stack_reference_strength(strength)
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.
- Parameters:
strength (
ReferenceStrength) –The reference strength to use for this resource.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- cfn_property_name(cdk_property_name)
- Parameters:
cdk_property_name (
str)- Return type:
Optional[str]
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the
CfnResourceobject. For dependencies on other stacks, returns theStackobject. The order of the array is not guaranteed.- Return type:
List[Union[Stack,CfnResource]]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
(deprecated) Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Deprecated:
Use
removeResourceDependencyinstead- Stability:
deprecated
- Return type:
None
- remove_resource_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
- with_(*mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple
with()calls if subsequent mixins should apply to added constructs.- Parameters:
mixins (
IMixin)- Return type:
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::Lambda::WebFunctionRevision'
- attr_created_at
The timestamp when the revision was created.
- CloudformationAttribute:
CreatedAt
- attr_function_arn
The Amazon Resource Name (ARN) of the function.
- CloudformationAttribute:
FunctionArn
- attr_revision_arn
The Amazon Resource Name (ARN) of the revision.
- CloudformationAttribute:
RevisionArn
- attr_revision_id
The unique identifier of the revision.
- CloudformationAttribute:
RevisionId
- attr_state
The current state of the revision.
- CloudformationAttribute:
State
- attr_state_reason
The reason for the revision’s current state.
- CloudformationAttribute:
StateReason
- build_config
The build configuration for the revision.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
A description of the revision.
- env
- function_name
The name of the web function this revision belongs to.
- kms_key_arn
The ARN of the KMS key used to encrypt the revision.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- service_config
The service configuration for the revision.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- web_function_revision_ref
A reference to a WebFunctionRevision resource.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_web_function_revision(x)
Checks whether the given object is a CfnWebFunctionRevision.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
BuildConfigProperty
- class CfnWebFunctionRevision.BuildConfigProperty(*, code_config, runtime_config)
Bases:
objectThe build configuration for the revision.
- Parameters:
code_config (
Union[IResolvable,CodeConfigProperty,Dict[str,Any]]) – The code configuration for the revision.runtime_config (
Union[IResolvable,RuntimeConfigProperty,Dict[str,Any]]) – The runtime configuration for the revision.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lambda as lambda_ build_config_property = lambda.CfnWebFunctionRevision.BuildConfigProperty( code_config=lambda.CfnWebFunctionRevision.CodeConfigProperty( s3_object=lambda.CfnWebFunctionRevision.S3ObjectProperty( bucket="bucket", key="key", # the properties below are optional version_id="versionId" ) ), runtime_config=lambda.CfnWebFunctionRevision.RuntimeConfigProperty( runtime="runtime" ) )
Attributes
- code_config
The code configuration for the revision.
- runtime_config
The runtime configuration for the revision.
CodeConfigProperty
- class CfnWebFunctionRevision.CodeConfigProperty(*, s3_object)
Bases:
objectThe code configuration for the revision.
- Parameters:
s3_object (
Union[IResolvable,S3ObjectProperty,Dict[str,Any]]) – The S3 location of the function code.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lambda as lambda_ code_config_property = lambda.CfnWebFunctionRevision.CodeConfigProperty( s3_object=lambda.CfnWebFunctionRevision.S3ObjectProperty( bucket="bucket", key="key", # the properties below are optional version_id="versionId" ) )
Attributes
- s3_object
The S3 location of the function code.
LoggingConfigProperty
- class CfnWebFunctionRevision.LoggingConfigProperty(*, application_log_level=None, log_group=None, system_log_level=None)
Bases:
objectThe logging configuration.
- Parameters:
application_log_level (
Optional[str]) – The application log level.log_group (
Optional[str]) – The CloudWatch log group name.system_log_level (
Optional[str]) – The system log level.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lambda as lambda_ logging_config_property = lambda.CfnWebFunctionRevision.LoggingConfigProperty( application_log_level="applicationLogLevel", log_group="logGroup", system_log_level="systemLogLevel" )
Attributes
- application_log_level
The application log level.
- log_group
The CloudWatch log group name.
RuntimeConfigProperty
- class CfnWebFunctionRevision.RuntimeConfigProperty(*, runtime)
Bases:
objectThe runtime configuration for the revision.
- Parameters:
runtime (
str) – The runtime identifier.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lambda as lambda_ runtime_config_property = lambda.CfnWebFunctionRevision.RuntimeConfigProperty( runtime="runtime" )
Attributes
S3ObjectProperty
- class CfnWebFunctionRevision.S3ObjectProperty(*, bucket, key, version_id=None)
Bases:
objectThe S3 location of the function code.
- Parameters:
bucket (
str) – The S3 bucket name.key (
str) – The S3 object key.version_id (
Optional[str]) – The S3 object version ID.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lambda as lambda_ s3_object_property = lambda.CfnWebFunctionRevision.S3ObjectProperty( bucket="bucket", key="key", # the properties below are optional version_id="versionId" )
Attributes
- bucket
The S3 bucket name.
- key
The S3 object key.
- version_id
The S3 object version ID.
ServiceConfigProperty
- class CfnWebFunctionRevision.ServiceConfigProperty(*, execution_role_arn, environment_variables=None, max_concurrency_per_environment=None, telemetry_config=None, timeout_seconds=None)
Bases:
objectThe service configuration for the revision.
- Parameters:
execution_role_arn (
str) – The ARN of the execution role.environment_variables (
Union[IResolvable,Mapping[str,str],None]) – Environment variables for the function.max_concurrency_per_environment (
Union[int,float,None]) – The maximum concurrency per environment.telemetry_config (
Union[IResolvable,TelemetryConfigProperty,Dict[str,Any],None]) – The telemetry configuration.timeout_seconds (
Union[int,float,None]) – The function timeout in seconds.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lambda as lambda_ service_config_property = lambda.CfnWebFunctionRevision.ServiceConfigProperty( execution_role_arn="executionRoleArn", # the properties below are optional environment_variables={ "environment_variables_key": "environmentVariables" }, max_concurrency_per_environment=123, telemetry_config=lambda.CfnWebFunctionRevision.TelemetryConfigProperty( logging_config=lambda.CfnWebFunctionRevision.LoggingConfigProperty( application_log_level="applicationLogLevel", log_group="logGroup", system_log_level="systemLogLevel" ) ), timeout_seconds=123 )
Attributes
- environment_variables
Environment variables for the function.
- execution_role_arn
The ARN of the execution role.
- max_concurrency_per_environment
The maximum concurrency per environment.
- telemetry_config
The telemetry configuration.
- timeout_seconds
The function timeout in seconds.
TelemetryConfigProperty
- class CfnWebFunctionRevision.TelemetryConfigProperty(*, logging_config=None)
Bases:
objectThe telemetry configuration.
- Parameters:
logging_config (
Union[IResolvable,LoggingConfigProperty,Dict[str,Any],None]) – The logging configuration.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lambda as lambda_ telemetry_config_property = lambda.CfnWebFunctionRevision.TelemetryConfigProperty( logging_config=lambda.CfnWebFunctionRevision.LoggingConfigProperty( application_log_level="applicationLogLevel", log_group="logGroup", system_log_level="systemLogLevel" ) )
Attributes
- logging_config
The logging configuration.