Class CfnUrl
The AWS::Lambda::Url
resource creates a function URL with the specified configuration parameters.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Lambda
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUrl : CfnResource, IInspectable
Syntax (vb)
Public Class CfnUrl
Inherits CfnResource
Implements IInspectable
Remarks
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
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;
var cfnUrl = new CfnUrl(this, "MyCfnUrl", new CfnUrlProps {
AuthType = "authType",
TargetFunctionArn = "targetFunctionArn",
// the properties below are optional
Cors = new CorsProperty {
AllowCredentials = false,
AllowHeaders = new [] { "allowHeaders" },
AllowMethods = new [] { "allowMethods" },
AllowOrigins = new [] { "allowOrigins" },
ExposeHeaders = new [] { "exposeHeaders" },
MaxAge = 123
},
InvokeMode = "invokeMode",
Qualifier = "qualifier"
});
Synopsis
Constructors
CfnUrl(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUrl(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnUrl(Construct, String, ICfnUrlProps) |
Properties
AttrFunctionArn | The Amazon Resource Name (ARN) of the function. |
AttrFunctionUrl | The HTTP URL endpoint for your function. |
AuthType | The type of authentication that your function URL uses. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Cors | The Cross-Origin Resource Sharing (CORS) settings for your function URL. |
InvokeMode | Use one of the following options:. |
Qualifier | The alias name. |
TargetFunctionArn | The name of the Lambda function. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUrl(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUrl(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUrl(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUrl(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnUrl(Construct, String, ICfnUrlProps)
public CfnUrl(Construct scope, string id, ICfnUrlProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnUrlProps
Resource properties.
Properties
AttrFunctionArn
The Amazon Resource Name (ARN) of the function.
public virtual string AttrFunctionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: FunctionArn
AttrFunctionUrl
The HTTP URL endpoint for your function.
public virtual string AttrFunctionUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: FunctionUrl
AuthType
The type of authentication that your function URL uses.
public virtual string AuthType { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Cors
The Cross-Origin Resource Sharing (CORS) settings for your function URL.
public virtual object Cors { get; set; }
Property Value
System.Object
InvokeMode
Use one of the following options:.
public virtual string InvokeMode { get; set; }
Property Value
System.String
Qualifier
The alias name.
public virtual string Qualifier { get; set; }
Property Value
System.String
TargetFunctionArn
The name of the Lambda function.
public virtual string TargetFunctionArn { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>