class FunctionUrlOriginAccessControl (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CloudFront.FunctionUrlOriginAccessControl |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#FunctionUrlOriginAccessControl |
![]() | software.amazon.awscdk.services.cloudfront.FunctionUrlOriginAccessControl |
![]() | aws_cdk.aws_cloudfront.FunctionUrlOriginAccessControl |
![]() | aws-cdk-lib » aws_cloudfront » FunctionUrlOriginAccessControl |
Implements
IConstruct
, IDependable
, IResource
, IOrigin
An Origin Access Control for Lambda Function URLs.
Example
import * as lambda from 'aws-cdk-lib/aws-lambda';
declare const fn: lambda.Function;
const fnUrl = fn.addFunctionUrl({
authType: lambda.FunctionUrlAuthType.AWS_IAM,
});
// Define a custom OAC
const oac = new cloudfront.FunctionUrlOriginAccessControl(this, 'MyOAC', {
originAccessControlName: 'CustomLambdaOAC',
signing: cloudfront.Signing.SIGV4_ALWAYS,
});
// Set up Lambda Function URL with OAC in CloudFront Distribution
new cloudfront.Distribution(this, 'MyDistribution', {
defaultBehavior: {
origin: origins.FunctionUrlOrigin.withOriginAccessControl(fnUrl, {
originAccessControl: oac,
}),
},
});
Initializer
new FunctionUrlOriginAccessControl(scope: Construct, id: string, props?: FunctionUrlOriginAccessControlProps)
Parameters
- scope
Construct
- id
string
- props
Function
Url Origin Access Control Props
Construct Props
Name | Type | Description |
---|---|---|
description? | string | A description of the origin access control. |
origin | string | A name to identify the origin access control, with a maximum length of 64 characters. |
signing? | Signing | Specifies which requests CloudFront signs and the signing protocol. |
description?
Type:
string
(optional, default: no description)
A description of the origin access control.
originAccessControlName?
Type:
string
(optional, default: a generated name)
A name to identify the origin access control, with a maximum length of 64 characters.
signing?
Type:
Signing
(optional, default: SIGV4_ALWAYS)
Specifies which requests CloudFront signs and the signing protocol.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
origin | string | The unique identifier of this Origin Access Control. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
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.
node
Type:
Node
The tree node.
originAccessControlId
Type:
string
The unique identifier of this Origin Access Control.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Imports a Lambda Function URL origin access control from its id. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromOriginAccessControlId(scope, id, originAccessControlId)
public static fromOriginAccessControlId(scope: Construct, id: string, originAccessControlId: string): IOriginAccessControl
Parameters
- scope
Construct
- id
string
- originAccessControlId
string
Returns
Imports a Lambda Function URL origin access control from its id.