Class: Aws::OpsWorks::Types::CreateLayerRequest

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorks::Types::CreateLayerRequest

Includes:

Structure

Defined in:

lib/aws-sdk-opsworks/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Hash<String,String>

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

• #auto_assign_elastic_ips ⇒ Boolean

  Whether to automatically assign an [Elastic IP address] to the layer’s instances.

• #auto_assign_public_ips ⇒ Boolean

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

• #cloud_watch_logs_configuration ⇒ Types::CloudWatchLogsConfiguration

  Specifies CloudWatch Logs configuration options for the layer.

• #custom_instance_profile_arn ⇒ String

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

• #custom_json ⇒ String

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

• #custom_recipes ⇒ Types::Recipes

  A ‘LayerCustomRecipes` object that specifies the layer custom recipes.

• #custom_security_group_ids ⇒ Array<String>

  An array containing the layer custom security group IDs.

• #enable_auto_healing ⇒ Boolean

  Whether to disable auto healing for the layer.

• #install_updates_on_boot ⇒ Boolean

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

• #lifecycle_event_configuration ⇒ Types::LifecycleEventConfiguration

  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.

• #name ⇒ String

  The layer name, which is used by the console.

• #packages ⇒ Array<String>

  An array of ‘Package` objects that describes the layer packages.

• #shortname ⇒ String

  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.

• #stack_id ⇒ String

  The layer stack ID.

• #type ⇒ String

  The layer type.

• #use_ebs_optimized_instances ⇒ Boolean

  Whether to use Amazon EBS-optimized instances.

• #volume_configurations ⇒ Array<Types::VolumeConfiguration>

  A ‘VolumeConfigurations` object that describes the layer’s Amazon EBS volumes.

Instance Attribute Details

#attributes ⇒ Hash<String,String>

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.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#auto_assign_elastic_ips ⇒ Boolean

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#auto_assign_public_ips ⇒ Boolean

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].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logs_configuration ⇒ Types::CloudWatchLogsConfiguration

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

Returns:

• (Types::CloudWatchLogsConfiguration)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#custom_instance_profile_arn ⇒ String

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

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#custom_json ⇒ String

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 CLI.

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#custom_recipes ⇒ Types::Recipes

A ‘LayerCustomRecipes` object that specifies the layer custom recipes.

Returns:

• (Types::Recipes)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#custom_security_group_ids ⇒ Array<String>

An array containing the layer custom security group IDs.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#enable_auto_healing ⇒ Boolean

Whether to disable auto healing for the layer.

Returns:

• (Boolean)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#install_updates_on_boot ⇒ Boolean

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.

<note markdown=“1”> To ensure that your instances have the latest security updates, we strongly recommend using the default value of ‘true`.

</note>

Returns:

• (Boolean)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_event_configuration ⇒ Types::LifecycleEventConfiguration

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:

• (Types::LifecycleEventConfiguration)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The layer name, which is used by the console. Layer names can be a maximum of 32 characters.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#packages ⇒ Array<String>

An array of ‘Package` objects that describes the layer packages.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#shortname ⇒ String

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. 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 OpsWorks Stacks. For more information, see the [Layer Reference].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/layers.html

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ String

The layer stack ID.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#use_ebs_optimized_instances ⇒ Boolean

Whether to use Amazon EBS-optimized instances.

Returns:

• (Boolean)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#volume_configurations ⇒ Array<Types::VolumeConfiguration>

A ‘VolumeConfigurations` object that describes the layer’s Amazon EBS volumes.

Returns:

• (Array<Types::VolumeConfiguration>)

# File 'lib/aws-sdk-opsworks/types.rb', line 1472

class CreateLayerRequest < Struct.new(
  :stack_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :custom_recipes,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end