Package software.amazon.awscdk.services.opsworks

Interface CfnLayerProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnLayerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.622Z") @Stability(Stable) public interface CfnLayerProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a 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();

  • Method Details

    • getAutoAssignElasticIps

      @Stability(Stable) @NotNull Object getAutoAssignElasticIps()
      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 Object 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 .

    • getEnableAutoHealing

      @Stability(Stable) @NotNull Object getEnableAutoHealing()
      Whether to disable auto healing for the layer.

    • getName

      @Stability(Stable) @NotNull String getName()
      The layer name, which is used by the console.

      Layer names can be a maximum of 32 characters.

    • getShortname

      @Stability(Stable) @NotNull 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.

      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 .

    • getStackId

      @Stability(Stable) @NotNull String getStackId()
      The layer stack ID.

    • getType

      @Stability(Stable) @NotNull String 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.

    • getAttributes

      @Stability(Stable) @Nullable default Object 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.

    • getCustomInstanceProfileArn

      @Stability(Stable) @Nullable default String 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 .

    • getCustomJson

      @Stability(Stable) @Nullable default Object 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 .

    • getCustomRecipes

      @Stability(Stable) @Nullable default Object getCustomRecipes()
      A LayerCustomRecipes object that specifies the layer custom recipes.

    • getCustomSecurityGroupIds

      @Stability(Stable) @Nullable default List<String> getCustomSecurityGroupIds()
      An array containing the layer custom security group IDs.

    • getInstallUpdatesOnBoot

      @Stability(Stable) @Nullable default Object 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 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 .

    • getLifecycleEventConfiguration

      @Stability(Stable) @Nullable default 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.

    • getLoadBasedAutoScaling

      @Stability(Stable) @Nullable default Object getLoadBasedAutoScaling()
      The load-based scaling configuration for the AWS OpsWorks layer.

    • getPackages

      @Stability(Stable) @Nullable default List<String> getPackages()
      An array of Package objects that describes the layer packages.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      Specifies one or more sets of tags (key–value pairs) to associate with this AWS OpsWorks layer.

      Use tags to manage your resources.

    • getUseEbsOptimizedInstances

      @Stability(Stable) @Nullable default Object getUseEbsOptimizedInstances()
      Whether to use Amazon EBS-optimized instances.

    • getVolumeConfigurations

      @Stability(Stable) @Nullable default Object getVolumeConfigurations()
      A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

    • builder

      @Stability(Stable) static CfnLayerProps.Builder builder()
      Returns:
      a CfnLayerProps.Builder of CfnLayerProps