Package software.amazon.awssdk.services.opsworks.model

Interface Layer.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Layer.Builder,Layer>, SdkBuilder<Layer.Builder,Layer>, SdkPojo
Enclosing class:
Layer
public static interface Layer.Builder extends SdkPojo, CopyableBuilder<Layer.Builder,Layer>

  • Method Details

    • arn

      Layer.Builder arn(String arn)

      The Amazon Resource Number (ARN) of a layer.

      Parameters:
      arn - The Amazon Resource Number (ARN) of a layer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackId

      Layer.Builder stackId(String stackId)

      The layer stack ID.

      Parameters:
      stackId - The layer stack ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • layerId

      Layer.Builder layerId(String layerId)

      The layer ID.

      Parameters:
      layerId - The layer ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      Layer.Builder type(String type)

      The layer type.

      Parameters:
      type - The layer type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      Layer.Builder type(LayerType type)

      The layer type.

      Parameters:
      type - The layer type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      Layer.Builder name(String name)

      The layer name.

      Parameters:
      name - The layer name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shortname

      Layer.Builder shortname(String shortname)

      The layer short name.

      Parameters:
      shortname - The layer short name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributesWithStrings

      Layer.Builder attributesWithStrings(Map<String,String> attributes)

      The layer attributes.

      For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value

      For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

      Parameters:
      attributes - The layer attributes.

      For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value

      For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      Layer.Builder attributes(Map<LayerAttributesKeys,String> attributes)

      The layer attributes.

      For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value

      For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

      Parameters:
      attributes - The layer attributes.

      For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value

      For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cloudWatchLogsConfiguration

      Layer.Builder cloudWatchLogsConfiguration(CloudWatchLogsConfiguration cloudWatchLogsConfiguration)

      The Amazon CloudWatch Logs configuration settings for the layer.

      Parameters:
      cloudWatchLogsConfiguration - The Amazon CloudWatch Logs configuration settings for the layer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cloudWatchLogsConfiguration

      default Layer.Builder cloudWatchLogsConfiguration(Consumer<CloudWatchLogsConfiguration.Builder> cloudWatchLogsConfiguration)

      The Amazon CloudWatch Logs configuration settings for the layer.

      This is a convenience method that creates an instance of the CloudWatchLogsConfiguration.Builder avoiding the need to create one manually via CloudWatchLogsConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchLogsConfiguration(CloudWatchLogsConfiguration).

      Parameters:
      cloudWatchLogsConfiguration - a consumer that will call methods on CloudWatchLogsConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customInstanceProfileArn

      Layer.Builder customInstanceProfileArn(String customInstanceProfileArn)

      The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

      Parameters:
      customInstanceProfileArn - The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customJson

      Layer.Builder customJson(String customJson)

      A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

      Parameters:
      customJson - A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customSecurityGroupIds

      Layer.Builder customSecurityGroupIds(Collection<String> customSecurityGroupIds)

      An array containing the layer's custom security group IDs.

      Parameters:
      customSecurityGroupIds - An array containing the layer's custom security group IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customSecurityGroupIds

      Layer.Builder customSecurityGroupIds(String... customSecurityGroupIds)

      An array containing the layer's custom security group IDs.

      Parameters:
      customSecurityGroupIds - An array containing the layer's custom security group IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultSecurityGroupNames

      Layer.Builder defaultSecurityGroupNames(Collection<String> defaultSecurityGroupNames)

      An array containing the layer's security group names.

      Parameters:
      defaultSecurityGroupNames - An array containing the layer's security group names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultSecurityGroupNames

      Layer.Builder defaultSecurityGroupNames(String... defaultSecurityGroupNames)

      An array containing the layer's security group names.

      Parameters:
      defaultSecurityGroupNames - An array containing the layer's security group names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • packages

      Layer.Builder packages(Collection<String> packages)

      An array of Package objects that describe the layer's packages.

      Parameters:
      packages - An array of Package objects that describe the layer's packages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • packages

      Layer.Builder packages(String... packages)

      An array of Package objects that describe the layer's packages.

      Parameters:
      packages - An array of Package objects that describe the layer's packages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      Layer.Builder volumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)

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

      Parameters:
      volumeConfigurations - A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      Layer.Builder volumeConfigurations(VolumeConfiguration... volumeConfigurations)

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

      Parameters:
      volumeConfigurations - A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      Layer.Builder volumeConfigurations(Consumer<VolumeConfiguration.Builder>... volumeConfigurations)

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

      This is a convenience method that creates an instance of the VolumeConfiguration.Builder avoiding the need to create one manually via VolumeConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to volumeConfigurations(List<VolumeConfiguration>).

      Parameters:
      volumeConfigurations - a consumer that will call methods on VolumeConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enableAutoHealing

      Layer.Builder enableAutoHealing(Boolean enableAutoHealing)

      Whether auto healing is disabled for the layer.

      Parameters:
      enableAutoHealing - Whether auto healing is disabled for the layer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoAssignElasticIps

      Layer.Builder autoAssignElasticIps(Boolean autoAssignElasticIps)

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

      Parameters:
      autoAssignElasticIps - Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoAssignPublicIps

      Layer.Builder autoAssignPublicIps(Boolean autoAssignPublicIps)

      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.

      Parameters:
      autoAssignPublicIps - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultRecipes

      Layer.Builder defaultRecipes(Recipes defaultRecipes)

      AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. You can also provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

      To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

      Parameters:
      defaultRecipes - AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. You can also provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

      To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultRecipes

      default Layer.Builder defaultRecipes(Consumer<Recipes.Builder> defaultRecipes)

      AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. You can also provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

      To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

      This is a convenience method that creates an instance of the Recipes.Builder avoiding the need to create one manually via Recipes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultRecipes(Recipes).

      Parameters:
      defaultRecipes - a consumer that will call methods on Recipes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customRecipes

      Layer.Builder customRecipes(Recipes customRecipes)

      A LayerCustomRecipes object that specifies the layer's custom recipes.

      Parameters:
      customRecipes - A LayerCustomRecipes object that specifies the layer's custom recipes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customRecipes

      default Layer.Builder customRecipes(Consumer<Recipes.Builder> customRecipes)

      A LayerCustomRecipes object that specifies the layer's custom recipes.

      This is a convenience method that creates an instance of the Recipes.Builder avoiding the need to create one manually via Recipes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customRecipes(Recipes).

      Parameters:
      customRecipes - a consumer that will call methods on Recipes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      Layer.Builder createdAt(String createdAt)

      Date when the layer was created.

      Parameters:
      createdAt - Date when the layer was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • installUpdatesOnBoot

      Layer.Builder installUpdatesOnBoot(Boolean installUpdatesOnBoot)

      Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

      We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

      Parameters:
      installUpdatesOnBoot - Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

      We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • useEbsOptimizedInstances

      Layer.Builder useEbsOptimizedInstances(Boolean useEbsOptimizedInstances)

      Whether the layer uses Amazon EBS-optimized instances.

      Parameters:
      useEbsOptimizedInstances - Whether the layer uses Amazon EBS-optimized instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycleEventConfiguration

      Layer.Builder lifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)

      A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

      Parameters:
      lifecycleEventConfiguration - A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycleEventConfiguration

      default Layer.Builder lifecycleEventConfiguration(Consumer<LifecycleEventConfiguration.Builder> lifecycleEventConfiguration)

      A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

      This is a convenience method that creates an instance of the LifecycleEventConfiguration.Builder avoiding the need to create one manually via LifecycleEventConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lifecycleEventConfiguration(LifecycleEventConfiguration).

      Parameters:
      lifecycleEventConfiguration - a consumer that will call methods on LifecycleEventConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: