software.amazon.awscdk.services.lambda

Class CfnLayerVersionPermission

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.lambda.CfnLayerVersionPermission

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-10T17:05:56.454Z")
 @Stability(value=Stable)
public class CfnLayerVersionPermission
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lambda::LayerVersionPermission`.

The AWS::Lambda::LayerVersionPermission resource adds permissions to the resource-based policy of a version of an Lambda layer . Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.

Since the release of the UpdateReplacePolicy both UpdateReplacePolicy and DeletionPolicy are required to protect your Resources/LayerPermissions from deletion.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 CfnLayerVersionPermission cfnLayerVersionPermission = CfnLayerVersionPermission.Builder.create(this, "MyCfnLayerVersionPermission")
         .action("action")
         .layerVersionArn("layerVersionArn")
         .principal("principal")
         // the properties below are optional
         .organizationId("organizationId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnLayerVersionPermission.Builder A fluent builder for CfnLayerVersionPermission.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLayerVersionPermission(Construct scope, String id, CfnLayerVersionPermissionProps props) Create a new `AWS::Lambda::LayerVersionPermission`.
protected	CfnLayerVersionPermission(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLayerVersionPermission(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAction() The API action that grants access to the layer.
protected Map<String,Object>	getCfnProperties()
String	getLayerVersionArn() The name or Amazon Resource Name (ARN) of the layer.
String	getOrganizationId() With the principal set to `*` , grant permission to all accounts in the specified organization.
String	getPrincipal() An account ID, or `*` to grant layer usage permission to all accounts in an organization, or all AWS accounts (if `organizationId` is not specified).
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAction(String value) The API action that grants access to the layer.
void	setLayerVersionArn(String value) The name or Amazon Resource Name (ARN) of the layer.
void	setOrganizationId(String value) With the principal set to `*` , grant permission to all accounts in the specified organization.
void	setPrincipal(String value) An account ID, or `*` to grant layer usage permission to all accounts in an organization, or all AWS accounts (if `organizationId` is not specified).

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLayerVersionPermission

protected CfnLayerVersionPermission(software.amazon.jsii.JsiiObjectRef objRef)

CfnLayerVersionPermission

protected CfnLayerVersionPermission(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnLayerVersionPermission

@Stability(value=Stable)
public CfnLayerVersionPermission(@NotNull
                                                          Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @NotNull
                                                          CfnLayerVersionPermissionProps props)

Create a new `AWS::Lambda::LayerVersionPermission`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAction

@Stability(value=Stable)
 @NotNull
public String getAction()

The API action that grants access to the layer.

For example, lambda:GetLayerVersion .

setAction

@Stability(value=Stable)
public void setAction(@NotNull
                                               String value)

The API action that grants access to the layer.

For example, lambda:GetLayerVersion .

getLayerVersionArn

@Stability(value=Stable)
 @NotNull
public String getLayerVersionArn()

The name or Amazon Resource Name (ARN) of the layer.

setLayerVersionArn

@Stability(value=Stable)
public void setLayerVersionArn(@NotNull
                                                        String value)

The name or Amazon Resource Name (ARN) of the layer.

getPrincipal

@Stability(value=Stable)
 @NotNull
public String getPrincipal()

An account ID, or `*` to grant layer usage permission to all accounts in an organization, or all AWS accounts (if `organizationId` is not specified).

For the last case, make sure that you really do want all AWS accounts to have usage permission to this layer.

setPrincipal

@Stability(value=Stable)
public void setPrincipal(@NotNull
                                                  String value)

An account ID, or `*` to grant layer usage permission to all accounts in an organization, or all AWS accounts (if `organizationId` is not specified).

For the last case, make sure that you really do want all AWS accounts to have usage permission to this layer.

getOrganizationId

@Stability(value=Stable)
 @Nullable
public String getOrganizationId()

With the principal set to `*` , grant permission to all accounts in the specified organization.

setOrganizationId

@Stability(value=Stable)
public void setOrganizationId(@Nullable
                                                       String value)

With the principal set to `*` , grant permission to all accounts in the specified organization.