@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:41.134Z") @Stability(value=Stable) public class CfnLayer extends CfnResource implements IInspectable
Creates a layer. For more information, see How to Create a Layer .
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .
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();
| Modifier and Type | Class and Description |
|---|---|
static interface |
CfnLayer.AutoScalingThresholdsProperty
Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances.
|
static class |
CfnLayer.Builder
A fluent builder for
CfnLayer. |
static interface |
CfnLayer.LifecycleEventConfigurationProperty
Specifies the lifecycle event configuration.
|
static interface |
CfnLayer.LoadBasedAutoScalingProperty
Describes a layer's load-based auto scaling configuration.
|
static interface |
CfnLayer.RecipesProperty
AWS OpsWorks Stacks supports five lifecycle events: *setup* , *configuration* , *deploy* , *undeploy* , and *shutdown* .
|
static interface |
CfnLayer.ShutdownEventConfigurationProperty
The Shutdown event configuration.
|
static interface |
CfnLayer.VolumeConfigurationProperty
Describes an Amazon EBS volume configuration.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnLayer(software.constructs.Construct scope,
String id,
CfnLayerProps props)
Create a new `AWS::OpsWorks::Layer`.
|
protected |
CfnLayer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnLayer(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
Object |
getAttributes()
One or more user-defined key-value pairs to be added to the stack attributes.
|
Object |
getAutoAssignElasticIps()
Whether to automatically assign an [Elastic IP address](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) 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.
|
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 AWS 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 AWS OpsWorks Stacks and by Chef recipes.
|
String |
getStackId()
The layer stack ID.
|
TagManager |
getTags()
Specifies one or more sets of tags (key–value pairs) to associate with this AWS 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.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAttributes(IResolvable value)
One or more user-defined key-value pairs to be added to the stack attributes.
|
void |
setAttributes(Map<String,String> 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) to the layer's instances.
|
void |
setAutoAssignElasticIps(IResolvable value)
Whether to automatically assign an [Elastic IP address](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) 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(CfnLayer.RecipesProperty value)
A `LayerCustomRecipes` object that specifies the layer custom recipes.
|
void |
setCustomRecipes(IResolvable 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(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 |
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 |
setLoadBasedAutoScaling(CfnLayer.LoadBasedAutoScalingProperty value)
The load-based scaling configuration for the AWS OpsWorks layer.
|
void |
setLoadBasedAutoScaling(IResolvable value)
The load-based scaling configuration for the AWS 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 AWS OpsWorks Stacks and by Chef recipes.
|
void |
setStackId(String value)
The layer stack ID.
|
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(IResolvable value)
A `VolumeConfigurations` object that describes the layer's Amazon EBS volumes.
|
void |
setVolumeConfigurations(List<Object> value)
A `VolumeConfigurations` object that describes the layer's Amazon EBS volumes.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnLayer(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnLayer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnLayer(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnLayerProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
Use tags to manage your resources.
@Stability(value=Stable) @NotNull public Object getAutoAssignElasticIps()
@Stability(value=Stable)
public void setAutoAssignElasticIps(@NotNull
Boolean value)
@Stability(value=Stable)
public void setAutoAssignElasticIps(@NotNull
IResolvable value)
@Stability(value=Stable) @NotNull public Object getAutoAssignPublicIps()
For more information, see How to Edit a Layer .
@Stability(value=Stable)
public void setAutoAssignPublicIps(@NotNull
Boolean value)
For more information, see How to Edit a Layer .
@Stability(value=Stable)
public void setAutoAssignPublicIps(@NotNull
IResolvable value)
For more information, see How to Edit a Layer .
@Stability(value=Stable) @NotNull public Object getCustomJson()
For more information, see Using Custom JSON . This feature is supported as of version 1.7.42 of the AWS CLI .
@Stability(value=Stable)
public void setCustomJson(@NotNull
Object value)
For more information, see Using Custom JSON . This feature is supported as of version 1.7.42 of the AWS CLI .
@Stability(value=Stable) @NotNull public Object getEnableAutoHealing()
@Stability(value=Stable)
public void setEnableAutoHealing(@NotNull
Boolean value)
@Stability(value=Stable)
public void setEnableAutoHealing(@NotNull
IResolvable value)
@Stability(value=Stable) @NotNull public String getName()
Layer names can be a maximum of 32 characters.
@Stability(value=Stable)
public void setName(@NotNull
String value)
Layer names can be a maximum of 32 characters.
@Stability(value=Stable) @NotNull public String getShortname()
The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
Built-in layer short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference .
@Stability(value=Stable)
public void setShortname(@NotNull
String value)
The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
Built-in layer short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference .
@Stability(value=Stable) @NotNull public String getStackId()
@Stability(value=Stable)
public void setStackId(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getType()
A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.
@Stability(value=Stable)
public void setType(@NotNull
String value)
A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.
@Stability(value=Stable) @Nullable public Object getAttributes()
To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
@Stability(value=Stable)
public void setAttributes(@Nullable
IResolvable value)
To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
@Stability(value=Stable)
public void setAttributes(@Nullable
Map<String,String> value)
To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
@Stability(value=Stable) @Nullable public String getCustomInstanceProfileArn()
For more information about IAM ARNs, see Using Identifiers .
@Stability(value=Stable)
public void setCustomInstanceProfileArn(@Nullable
String value)
For more information about IAM ARNs, see Using Identifiers .
@Stability(value=Stable) @Nullable public Object getCustomRecipes()
@Stability(value=Stable)
public void setCustomRecipes(@Nullable
CfnLayer.RecipesProperty value)
@Stability(value=Stable)
public void setCustomRecipes(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public List<String> getCustomSecurityGroupIds()
@Stability(value=Stable)
public void setCustomSecurityGroupIds(@Nullable
List<String> value)
@Stability(value=Stable) @Nullable public Object getInstallUpdatesOnBoot()
The default value is true . To control when updates are installed, set this value to false . You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
To ensure that your instances have the latest security updates, we strongly recommend using the default value of
true.
@Stability(value=Stable)
public void setInstallUpdatesOnBoot(@Nullable
Boolean value)
The default value is true . To control when updates are installed, set this value to false . You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
To ensure that your instances have the latest security updates, we strongly recommend using the default value of
true.
@Stability(value=Stable)
public void setInstallUpdatesOnBoot(@Nullable
IResolvable value)
The default value is true . To control when updates are installed, set this value to false . You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
To ensure that your instances have the latest security updates, we strongly recommend using the default value of
true.
@Stability(value=Stable) @Nullable public Object getLifecycleEventConfiguration()
@Stability(value=Stable)
public void setLifecycleEventConfiguration(@Nullable
CfnLayer.LifecycleEventConfigurationProperty value)
@Stability(value=Stable)
public void setLifecycleEventConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getLoadBasedAutoScaling()
@Stability(value=Stable)
public void setLoadBasedAutoScaling(@Nullable
CfnLayer.LoadBasedAutoScalingProperty value)
@Stability(value=Stable)
public void setLoadBasedAutoScaling(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public List<String> getPackages()
@Stability(value=Stable)
public void setPackages(@Nullable
List<String> value)
@Stability(value=Stable) @Nullable public Object getUseEbsOptimizedInstances()
@Stability(value=Stable)
public void setUseEbsOptimizedInstances(@Nullable
Boolean value)
@Stability(value=Stable)
public void setUseEbsOptimizedInstances(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getVolumeConfigurations()
@Stability(value=Stable)
public void setVolumeConfigurations(@Nullable
IResolvable value)
Copyright © 2022. All rights reserved.