Class CfnLayerVersionPermission
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.lambda.CfnLayerVersionPermission
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-17T19:20:30.816Z")
@Stability(Stable)
public class CfnLayerVersionPermission
extends CfnResource
implements IInspectable
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
andDeletionPolicy
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnLayerVersionPermission
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnLayerVersionPermission
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnLayerVersionPermission
(software.amazon.jsii.JsiiObjectRef objRef) CfnLayerVersionPermission
(software.constructs.Construct scope, String id, CfnLayerVersionPermissionProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe API action that grants access to the layer.ID generated by service.The name or Amazon Resource Name (ARN) of the layer.With the principal set to*
, grant permission to all accounts in the specified organization.An account ID, or*
to grant layer usage permission to all accounts in an organization, or all AWS accounts (iforganizationId
is not specified).void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
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 (iforganizationId
is not specified).Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnLayerVersionPermission
protected CfnLayerVersionPermission(software.amazon.jsii.JsiiObjectRef objRef) -
CfnLayerVersionPermission
protected CfnLayerVersionPermission(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnLayerVersionPermission
@Stability(Stable) public CfnLayerVersionPermission(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLayerVersionPermissionProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
ID generated by service. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAction
The API action that grants access to the layer. -
setAction
The API action that grants access to the layer. -
getLayerVersionArn
The name or Amazon Resource Name (ARN) of the layer. -
setLayerVersionArn
The name or Amazon Resource Name (ARN) of the layer. -
getPrincipal
An account ID, or*
to grant layer usage permission to all accounts in an organization, or all AWS accounts (iforganizationId
is not specified). -
setPrincipal
An account ID, or*
to grant layer usage permission to all accounts in an organization, or all AWS accounts (iforganizationId
is not specified). -
getOrganizationId
With the principal set to*
, grant permission to all accounts in the specified organization. -
setOrganizationId
With the principal set to*
, grant permission to all accounts in the specified organization.
-