Interface CfnLayerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnLayerProps.Jsii$Proxy
CfnLayer
.
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; CfnLayerProps cfnLayerProps = CfnLayerProps.builder() .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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnLayerProps
static final class
An implementation forCfnLayerProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnLayerProps.Builder
builder()
default Object
One or more user-defined key-value pairs to be added to the stack attributes.Whether to automatically assign an Elastic IP address to the layer's instances.For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.default String
The ARN of an IAM profile to be used for the layer's EC2 instances.default Object
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.default Object
ALayerCustomRecipes
object that specifies the layer custom recipes.An array containing the layer custom security group IDs.Whether to disable auto healing for the layer.default Object
Whether to install operating system and package updates when the instance boots.default Object
ALifeCycleEventConfiguration
object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.default Object
The load-based scaling configuration for the AWS OpsWorks layer.getName()
The layer name, which is used by the console.An array ofPackage
objects that describes the layer packages.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.The layer stack ID.getTags()
Specifies one or more sets of tags (key–value pairs) to associate with this AWS OpsWorks layer.getType()
The layer type.default Object
Whether to use Amazon EBS-optimized instances.default Object
AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAutoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer .- See Also:
-
getAutoAssignPublicIps
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.For more information, see How to Edit a Layer .
- See Also:
-
getEnableAutoHealing
Whether to disable auto healing for the layer.- See Also:
-
getName
The layer name, which is used by the console.Layer names can be a maximum of 32 characters.
- See Also:
-
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.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 .
- See Also:
-
getStackId
The layer stack ID.- See Also:
-
getType
The layer type.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.
- See Also:
-
getAttributes
One or more user-defined key-value pairs to be added to the stack attributes.To create a cluster layer, set the
EcsClusterArn
attribute to the cluster's ARN.- See Also:
-
getCustomInstanceProfileArn
The ARN of an IAM profile to be used for the layer's EC2 instances.For more information about IAM ARNs, see Using Identifiers .
- See Also:
-
getCustomJson
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.For more information, see Using Custom JSON . This feature is supported as of version 1.7.42 of the AWS CLI .
- See Also:
-
getCustomRecipes
ALayerCustomRecipes
object that specifies the layer custom recipes.- See Also:
-
getCustomSecurityGroupIds
An array containing the layer custom security group IDs.- See Also:
-
getInstallUpdatesOnBoot
Whether to install operating system and package updates when the instance boots.The default value is
true
. To control when updates are installed, set this value tofalse
. You must then update your instances manually by usingCreateDeployment
to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.To ensure that your instances have the latest security updates, we strongly recommend using the default value of
true
.- See Also:
-
getLifecycleEventConfiguration
ALifeCycleEventConfiguration
object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.- See Also:
-
getLoadBasedAutoScaling
The load-based scaling configuration for the AWS OpsWorks layer.- See Also:
-
getPackages
An array ofPackage
objects that describes the layer packages.- See Also:
-
getTags
Specifies one or more sets of tags (key–value pairs) to associate with this AWS OpsWorks layer.Use tags to manage your resources.
- See Also:
-
getUseEbsOptimizedInstances
Whether to use Amazon EBS-optimized instances.- See Also:
-
getVolumeConfigurations
AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.- See Also:
-
builder
- Returns:
- a
CfnLayerProps.Builder
ofCfnLayerProps
-