Package software.amazon.awscdk.services.opsworks

Class CfnLayer

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.opsworks.CfnLayer

All Implemented Interfaces:

IInspectable, IEnvironmentAware, ILayerRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:14.244Z")
@Stability(Stable)
public class CfnLayer
extends CfnResource
implements IInspectable, ILayerRef, ITaggable

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html.

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.opsworks.*;
 Object customJson;
 CfnLayer cfnLayer = CfnLayer.Builder.create(this, "MyCfnLayer")
         .autoAssignElasticIps(false)
         .autoAssignPublicIps(false)
         .enableAutoHealing(false)
         .name("name")
         .shortname("shortname")
         .stackId("stackId")
         .type("type")
         // the properties below are optional
         .attributes(Map.of(
                 "attributesKey", "attributes"))
         .customInstanceProfileArn("customInstanceProfileArn")
         .customJson(customJson)
         .customRecipes(RecipesProperty.builder()
                 .configure(List.of("configure"))
                 .deploy(List.of("deploy"))
                 .setup(List.of("setup"))
                 .shutdown(List.of("shutdown"))
                 .undeploy(List.of("undeploy"))
                 .build())
         .customSecurityGroupIds(List.of("customSecurityGroupIds"))
         .installUpdatesOnBoot(false)
         .lifecycleEventConfiguration(LifecycleEventConfigurationProperty.builder()
                 .shutdownEventConfiguration(ShutdownEventConfigurationProperty.builder()
                         .delayUntilElbConnectionsDrained(false)
                         .executionTimeout(123)
                         .build())
                 .build())
         .loadBasedAutoScaling(LoadBasedAutoScalingProperty.builder()
                 .downScaling(AutoScalingThresholdsProperty.builder()
                         .cpuThreshold(123)
                         .ignoreMetricsTime(123)
                         .instanceCount(123)
                         .loadThreshold(123)
                         .memoryThreshold(123)
                         .thresholdsWaitTime(123)
                         .build())
                 .enable(false)
                 .upScaling(AutoScalingThresholdsProperty.builder()
                         .cpuThreshold(123)
                         .ignoreMetricsTime(123)
                         .instanceCount(123)
                         .loadThreshold(123)
                         .memoryThreshold(123)
                         .thresholdsWaitTime(123)
                         .build())
                 .build())
         .packages(List.of("packages"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useEbsOptimizedInstances(false)
         .volumeConfigurations(List.of(VolumeConfigurationProperty.builder()
                 .encrypted(false)
                 .iops(123)
                 .mountPoint("mountPoint")
                 .numberOfDisks(123)
                 .raidLevel(123)
                 .size(123)
                 .volumeType("volumeType")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnLayer.AutoScalingThresholdsProperty	Example:
static final class	CfnLayer.Builder	A fluent builder for CfnLayer.
static interface	CfnLayer.LifecycleEventConfigurationProperty	Example:
static interface	CfnLayer.LoadBasedAutoScalingProperty	Example:
static interface	CfnLayer.RecipesProperty	Example:
static interface	CfnLayer.ShutdownEventConfigurationProperty	Example:
static interface	CfnLayer.VolumeConfigurationProperty	Example:

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.opsworks.ILayerRef

ILayerRef.Jsii$Default, ILayerRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnLayer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLayer(software.amazon.jsii.JsiiObjectRef objRef)
	CfnLayer(software.constructs.Construct scope, String id, CfnLayerProps props)	Create a new AWS::OpsWorks::Layer.

Method Summary

Modifier and Type	Method	Description
Object	getAttributes()	One or more user-defined key-value pairs to be added to the stack attributes.
String	getAttrId()
Object	getAutoAssignElasticIps()	Whether to automatically assign an Elastic IP address to the layer's instances.
Object	getAutoAssignPublicIps()	For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.
protected Map<String,Object>	getCfnProperties()
String	getCustomInstanceProfileArn()	The ARN of an IAM profile to be used for the layer's EC2 instances.
Object	getCustomJson()	A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.
Object	getCustomRecipes()	A LayerCustomRecipes object that specifies the layer custom recipes.
List<String>	getCustomSecurityGroupIds()	An array containing the layer custom security group IDs.
Object	getEnableAutoHealing()	Whether to disable auto healing for the layer.
Object	getInstallUpdatesOnBoot()	Whether to install operating system and package updates when the instance boots.
LayerReference	getLayerRef()	A reference to a Layer resource.
Object	getLifecycleEventConfiguration()	A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
Object	getLoadBasedAutoScaling()	The load-based scaling configuration for the OpsWorks layer.
String	getName()	The layer name, which is used by the console.
List<String>	getPackages()	An array of Package objects that describes the layer packages.
String	getShortname()	For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes.
String	getStackId()	The layer stack ID.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Specifies one or more sets of tags (key–value pairs) to associate with this OpsWorks layer.
String	getType()	The layer type.
Object	getUseEbsOptimizedInstances()	Whether to use Amazon EBS-optimized instances.
Object	getVolumeConfigurations()	A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnLayer(Object x)	Checks whether the given object is a CfnLayer.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAttributes(Map<String,String> value)	One or more user-defined key-value pairs to be added to the stack attributes.
void	setAttributes(IResolvable value)	One or more user-defined key-value pairs to be added to the stack attributes.
void	setAutoAssignElasticIps(Boolean value)	Whether to automatically assign an Elastic IP address to the layer's instances.
void	setAutoAssignElasticIps(IResolvable value)	Whether to automatically assign an Elastic IP address to the layer's instances.
void	setAutoAssignPublicIps(Boolean value)	For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.
void	setAutoAssignPublicIps(IResolvable value)	For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.
void	setCustomInstanceProfileArn(String value)	The ARN of an IAM profile to be used for the layer's EC2 instances.
void	setCustomJson(Object value)	A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.
void	setCustomRecipes(IResolvable value)	A LayerCustomRecipes object that specifies the layer custom recipes.
void	setCustomRecipes(CfnLayer.RecipesProperty value)	A LayerCustomRecipes object that specifies the layer custom recipes.
void	setCustomSecurityGroupIds(List<String> value)	An array containing the layer custom security group IDs.
void	setEnableAutoHealing(Boolean value)	Whether to disable auto healing for the layer.
void	setEnableAutoHealing(IResolvable value)	Whether to disable auto healing for the layer.
void	setInstallUpdatesOnBoot(Boolean value)	Whether to install operating system and package updates when the instance boots.
void	setInstallUpdatesOnBoot(IResolvable value)	Whether to install operating system and package updates when the instance boots.
void	setLifecycleEventConfiguration(IResolvable value)	A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
void	setLifecycleEventConfiguration(CfnLayer.LifecycleEventConfigurationProperty value)	A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
void	setLoadBasedAutoScaling(IResolvable value)	The load-based scaling configuration for the OpsWorks layer.
void	setLoadBasedAutoScaling(CfnLayer.LoadBasedAutoScalingProperty value)	The load-based scaling configuration for the OpsWorks layer.
void	setName(String value)	The layer name, which is used by the console.
void	setPackages(List<String> value)	An array of Package objects that describes the layer packages.
void	setShortname(String value)	For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes.
void	setStackId(String value)	The layer stack ID.
void	setTagsRaw(List<CfnTag> value)	Specifies one or more sets of tags (key–value pairs) to associate with this OpsWorks layer.
void	setType(String value)	The layer type.
void	setUseEbsOptimizedInstances(Boolean value)	Whether to use Amazon EBS-optimized instances.
void	setUseEbsOptimizedInstances(IResolvable value)	Whether to use Amazon EBS-optimized instances.
void	setVolumeConfigurations(List<Object> value)	A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
void	setVolumeConfigurations(IResolvable value)	A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnLayer

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

CfnLayer

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

CfnLayer

@Stability(Stable)
public CfnLayer(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnLayerProps props)

Create a new AWS::OpsWorks::Layer.

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

isCfnLayer

@Stability(Stable)
@NotNull
public static Boolean isCfnLayer(@NotNull
 Object x)

Checks whether the given object is a CfnLayer.

Parameters:

x - This parameter is required.

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getLayerRef

@Stability(Stable)
@NotNull
public LayerReference getLayerRef()

A reference to a Layer resource.

Specified by:

getLayerRef in interface ILayerRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAutoAssignElasticIps

@Stability(Stable)
@NotNull
public Object getAutoAssignElasticIps()

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer .

Returns union: either Boolean or IResolvable

setAutoAssignElasticIps

@Stability(Stable)
public void setAutoAssignElasticIps(@NotNull
 Boolean value)

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer .

setAutoAssignElasticIps

@Stability(Stable)
public void setAutoAssignElasticIps(@NotNull
 IResolvable value)

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer .

getAutoAssignPublicIps

@Stability(Stable)
@NotNull
public Object getAutoAssignPublicIps()

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.

Returns union: either Boolean or IResolvable

setAutoAssignPublicIps

@Stability(Stable)
public void setAutoAssignPublicIps(@NotNull
 Boolean value)

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.

setAutoAssignPublicIps

@Stability(Stable)
public void setAutoAssignPublicIps(@NotNull
 IResolvable value)

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.

getEnableAutoHealing

@Stability(Stable)
@NotNull
public Object getEnableAutoHealing()

Whether to disable auto healing for the layer.

Returns union: either Boolean or IResolvable

setEnableAutoHealing

@Stability(Stable)
public void setEnableAutoHealing(@NotNull
 Boolean value)

Whether to disable auto healing for the layer.

setEnableAutoHealing

@Stability(Stable)
public void setEnableAutoHealing(@NotNull
 IResolvable value)

Whether to disable auto healing for the layer.

getName

@Stability(Stable)
@NotNull
public String getName()

The layer name, which is used by the console.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The layer name, which is used by the console.

getShortname

@Stability(Stable)
@NotNull
public String getShortname()

For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes.

setShortname

@Stability(Stable)
public void setShortname(@NotNull
 String value)

For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes.

getStackId

@Stability(Stable)
@NotNull
public String getStackId()

The layer stack ID.

setStackId

@Stability(Stable)
public void setStackId(@NotNull
 String value)

The layer stack ID.

getType

@Stability(Stable)
@NotNull
public String getType()

The layer type.

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

The layer type.

getAttributes

@Stability(Stable)
@Nullable
public Object getAttributes()

One or more user-defined key-value pairs to be added to the stack attributes.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

setAttributes

@Stability(Stable)
public void setAttributes(@Nullable
 Map<String,String> value)

One or more user-defined key-value pairs to be added to the stack attributes.

setAttributes

@Stability(Stable)
public void setAttributes(@Nullable
 IResolvable value)

One or more user-defined key-value pairs to be added to the stack attributes.

getCustomInstanceProfileArn

@Stability(Stable)
@Nullable
public String getCustomInstanceProfileArn()

The ARN of an IAM profile to be used for the layer's EC2 instances.

setCustomInstanceProfileArn

@Stability(Stable)
public void setCustomInstanceProfileArn(@Nullable
 String value)

The ARN of an IAM profile to be used for the layer's EC2 instances.

getCustomJson

@Stability(Stable)
@Nullable
public Object getCustomJson()

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.

setCustomJson

@Stability(Stable)
public void setCustomJson(@Nullable
 Object value)

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.

getCustomRecipes

@Stability(Stable)
@Nullable
public Object getCustomRecipes()

A LayerCustomRecipes object that specifies the layer custom recipes.

Returns union: either IResolvable or CfnLayer.RecipesProperty

setCustomRecipes

@Stability(Stable)
public void setCustomRecipes(@Nullable
 IResolvable value)

A LayerCustomRecipes object that specifies the layer custom recipes.

setCustomRecipes

@Stability(Stable)
public void setCustomRecipes(@Nullable
 CfnLayer.RecipesProperty value)

A LayerCustomRecipes object that specifies the layer custom recipes.

getCustomSecurityGroupIds

@Stability(Stable)
@Nullable
public List<String> getCustomSecurityGroupIds()

An array containing the layer custom security group IDs.

setCustomSecurityGroupIds

@Stability(Stable)
public void setCustomSecurityGroupIds(@Nullable
 List<String> value)

An array containing the layer custom security group IDs.

getInstallUpdatesOnBoot

@Stability(Stable)
@Nullable
public Object getInstallUpdatesOnBoot()

Whether to install operating system and package updates when the instance boots.

Returns union: either Boolean or IResolvable

setInstallUpdatesOnBoot

@Stability(Stable)
public void setInstallUpdatesOnBoot(@Nullable
 Boolean value)

Whether to install operating system and package updates when the instance boots.

setInstallUpdatesOnBoot

@Stability(Stable)
public void setInstallUpdatesOnBoot(@Nullable
 IResolvable value)

Whether to install operating system and package updates when the instance boots.

getLifecycleEventConfiguration

@Stability(Stable)
@Nullable
public Object getLifecycleEventConfiguration()

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

Returns union: either IResolvable or CfnLayer.LifecycleEventConfigurationProperty

setLifecycleEventConfiguration

@Stability(Stable)
public void setLifecycleEventConfiguration(@Nullable
 IResolvable value)

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

setLifecycleEventConfiguration

@Stability(Stable)
public void setLifecycleEventConfiguration(@Nullable
 CfnLayer.LifecycleEventConfigurationProperty value)

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

getLoadBasedAutoScaling

@Stability(Stable)
@Nullable
public Object getLoadBasedAutoScaling()

The load-based scaling configuration for the OpsWorks layer.

Returns union: either IResolvable or CfnLayer.LoadBasedAutoScalingProperty

setLoadBasedAutoScaling

@Stability(Stable)
public void setLoadBasedAutoScaling(@Nullable
 IResolvable value)

The load-based scaling configuration for the OpsWorks layer.

setLoadBasedAutoScaling

@Stability(Stable)
public void setLoadBasedAutoScaling(@Nullable
 CfnLayer.LoadBasedAutoScalingProperty value)

The load-based scaling configuration for the OpsWorks layer.

getPackages

@Stability(Stable)
@Nullable
public List<String> getPackages()

An array of Package objects that describes the layer packages.

setPackages

@Stability(Stable)
public void setPackages(@Nullable
 List<String> value)

An array of Package objects that describes the layer packages.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Specifies one or more sets of tags (key–value pairs) to associate with this OpsWorks layer.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Specifies one or more sets of tags (key–value pairs) to associate with this OpsWorks layer.

getUseEbsOptimizedInstances

@Stability(Stable)
@Nullable
public Object getUseEbsOptimizedInstances()

Whether to use Amazon EBS-optimized instances.

Returns union: either Boolean or IResolvable

setUseEbsOptimizedInstances

@Stability(Stable)
public void setUseEbsOptimizedInstances(@Nullable
 Boolean value)

Whether to use Amazon EBS-optimized instances.

setUseEbsOptimizedInstances

@Stability(Stable)
public void setUseEbsOptimizedInstances(@Nullable
 IResolvable value)

Whether to use Amazon EBS-optimized instances.

getVolumeConfigurations

@Stability(Stable)
@Nullable
public Object getVolumeConfigurations()

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLayer.VolumeConfigurationProperty>

setVolumeConfigurations

@Stability(Stable)
public void setVolumeConfigurations(@Nullable
 IResolvable value)

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

setVolumeConfigurations

@Stability(Stable)
public void setVolumeConfigurations(@Nullable
 List<Object> value)

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.