CfnUrl
- class aws_cdk.aws_lambda.CfnUrl(scope, id, *, auth_type, target_function_arn, cors=None, invoke_mode=None, qualifier=None)
Bases:
CfnResource
The
AWS::Lambda::Url
resource creates a function URL with the specified configuration parameters.A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html
- CloudformationResource:
AWS::Lambda::Url
- 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_url = lambda_.CfnUrl(self, "MyCfnUrl", auth_type="authType", target_function_arn="targetFunctionArn", # the properties below are optional cors=lambda.CfnUrl.CorsProperty( allow_credentials=False, allow_headers=["allowHeaders"], allow_methods=["allowMethods"], allow_origins=["allowOrigins"], expose_headers=["exposeHeaders"], max_age=123 ), invoke_mode="invokeMode", qualifier="qualifier" )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).auth_type (
str
) – The type of authentication that your function URL uses. Set toAWS_IAM
if you want to restrict access to authenticated users only. Set toNONE
if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs .target_function_arn (
str
) – The name of the Lambda function. Name formats - Function name -my-function
. - Function ARN -lambda: : :function:my-function
. - Partial ARN -:function:my-function
. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.cors (
Union
[IResolvable
,CorsProperty
,Dict
[str
,Any
],None
]) – The Cross-Origin Resource Sharing (CORS) settings for your function URL.invoke_mode (
Optional
[str
]) – Use one of the following options:. -BUFFERED
– This is the default option. Lambda invokes your function using theInvoke
API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB. -RESPONSE_STREAM
– Your function streams payload results as they become available. Lambda invokes your function using theInvokeWithResponseStream
API operation. The maximum response payload size is 20 MB, however, you can request a quota increase .qualifier (
Optional
[str
]) – The alias name.
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)
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.
- Parameters:
target (
CfnResource
) –- 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.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- 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
addPropertyOverride
or prefixpath
with “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
value
argument toaddOverride
will 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
- 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
- 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 this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[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)
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
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::Lambda::Url'
- attr_function_arn
The Amazon Resource Name (ARN) of the function.
- CloudformationAttribute:
FunctionArn
- attr_function_url
The HTTP URL endpoint for your function.
- CloudformationAttribute:
FunctionUrl
- auth_type
The type of authentication that your function URL uses.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- cors
//developer.mozilla.org/en-US/docs/Web/HTTP/CORS>`_ settings for your function URL.
- Type:
The `Cross-Origin Resource Sharing (CORS) <https
- Type:
//docs.aws.amazon.com/https
- 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.
- invoke_mode
.
- Type:
Use one of the following options
- 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.
- qualifier
The alias name.
- 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 })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- target_function_arn
The name of the Lambda function.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to 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_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will 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
x
is an object created from a class which extendsConstruct
.
CorsProperty
- class CfnUrl.CorsProperty(*, allow_credentials=None, allow_headers=None, allow_methods=None, allow_origins=None, expose_headers=None, max_age=None)
Bases:
object
The Cross-Origin Resource Sharing (CORS) settings for your function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.
- Parameters:
allow_credentials (
Union
[bool
,IResolvable
,None
]) – Whether you want to allow cookies or other credentials in requests to your function URL. The default isfalse
.allow_headers (
Optional
[Sequence
[str
]]) – The HTTP headers that origins can include in requests to your function URL. For example:Date
,Keep-Alive
,X-Custom-Header
.allow_methods (
Optional
[Sequence
[str
]]) – The HTTP methods that are allowed when calling your function URL. For example:GET
,POST
,DELETE
, or the wildcard character (*
).allow_origins (
Optional
[Sequence
[str
]]) – The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example:https://www.example.com
,http://localhost:60905
. Alternatively, you can grant access to all origins with the wildcard character (*
).expose_headers (
Optional
[Sequence
[str
]]) – The HTTP headers in your function response that you want to expose to origins that call your function URL. For example:Date
,Keep-Alive
,X-Custom-Header
.max_age (
Union
[int
,float
,None
]) – The maximum amount of time, in seconds, that browsers can cache results of a preflight request. By default, this is set to0
, which means the browser will not cache results.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html
- 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_ cors_property = lambda.CfnUrl.CorsProperty( allow_credentials=False, allow_headers=["allowHeaders"], allow_methods=["allowMethods"], allow_origins=["allowOrigins"], expose_headers=["exposeHeaders"], max_age=123 )
Attributes
- allow_credentials
Whether you want to allow cookies or other credentials in requests to your function URL.
The default is
false
.
- allow_headers
The HTTP headers that origins can include in requests to your function URL.
For example:
Date
,Keep-Alive
,X-Custom-Header
.
- allow_methods
The HTTP methods that are allowed when calling your function URL.
For example:
GET
,POST
,DELETE
, or the wildcard character (*
).
- allow_origins
The origins that can access your function URL.
You can list any number of specific origins, separated by a comma. For example:
https://www.example.com
,http://localhost:60905
.Alternatively, you can grant access to all origins with the wildcard character (
*
).
- expose_headers
The HTTP headers in your function response that you want to expose to origins that call your function URL.
For example:
Date
,Keep-Alive
,X-Custom-Header
.
- max_age
The maximum amount of time, in seconds, that browsers can cache results of a preflight request.
By default, this is set to
0
, which means the browser will not cache results.