aws-sdk-opsworks 1.0.0.rc1

data/lib/aws-sdk-opsworks/customizations.rb

@@ -0,0 +1,7 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+

data/lib/aws-sdk-opsworks/errors.rb

@@ -0,0 +1,23 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module OpsWorks
+    module Errors
+
+      extend Aws::Errors::DynamicErrors
+
+      # Raised when calling #load or #data on a resource class that can not be
+      # loaded.  This can happen when:
+      #
+      # * A resource class has identifiers, but no data attributes.
+      # * Resource data is only available when making an API call that
+      # enumerates all resources of that type.
+      class ResourceNotLoadable < RuntimeError; end
+    end
+  end
+end

data/lib/aws-sdk-opsworks/layer.rb

@@ -0,0 +1,298 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module OpsWorks
+    class Layer
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(id, options = {})
+      #   @param [String] id
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :id
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @id = extract_id(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def id
+        @id
+      end
+
+      # The layer stack ID.
+      # @return [String]
+      def stack_id
+        data.stack_id
+      end
+
+      # The layer ID.
+      # @return [String]
+      def layer_id
+        data.layer_id
+      end
+
+      # The layer type.
+      # @return [String]
+      def type
+        data.type
+      end
+
+      # The layer name.
+      # @return [String]
+      def name
+        data.name
+      end
+
+      # The layer short name.
+      # @return [String]
+      def shortname
+        data.shortname
+      end
+
+      # The layer attributes.
+      #
+      # For the `HaproxyStatsPassword`, `MysqlRootPassword`, and
+      # `GangliaPassword` attributes, AWS OpsWorks returns
+      # `*****FILTERED*****` instead of the actual value
+      #
+      # For an ECS Cluster layer, AWS OpsWorks the `EcsClusterArn` attribute
+      # is set to the cluster's ARN.
+      # @return [Hash<String,String>]
+      def attributes
+        data.attributes
+      end
+
+      # 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][1].
+      #
+      #
+      #
+      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      # @return [String]
+      def custom_instance_profile_arn
+        data.custom_instance_profile_arn
+      end
+
+      # A JSON formatted string containing the layer's custom stack
+      # configuration and deployment attributes.
+      # @return [String]
+      def custom_json
+        data.custom_json
+      end
+
+      # An array containing the layer's custom security group IDs.
+      # @return [Array<String>]
+      def custom_security_group_ids
+        data.custom_security_group_ids
+      end
+
+      # An array containing the layer's security group names.
+      # @return [Array<String>]
+      def default_security_group_names
+        data.default_security_group_names
+      end
+
+      # An array of `Package` objects that describe the layer's packages.
+      # @return [Array<String>]
+      def packages
+        data.packages
+      end
+
+      # A `VolumeConfigurations` object that describes the layer's Amazon EBS
+      # volumes.
+      # @return [Array<Types::VolumeConfiguration>]
+      def volume_configurations
+        data.volume_configurations
+      end
+
+      # Whether auto healing is disabled for the layer.
+      # @return [Boolean]
+      def enable_auto_healing
+        data.enable_auto_healing
+      end
+
+      # Whether to automatically assign an [Elastic IP address][1] to the
+      # layer's instances. For more information, see [How to Edit a
+      # Layer][2].
+      #
+      #
+      #
+      # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html
+      # [2]: http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html
+      # @return [Boolean]
+      def auto_assign_elastic_ips
+        data.auto_assign_elastic_ips
+      end
+
+      # 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].
+      #
+      #
+      #
+      # [1]: http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html
+      # @return [Boolean]
+      def auto_assign_public_ips
+        data.auto_assign_public_ips
+      end
+
+      # AWS OpsWorks supports five lifecycle events: **setup**,
+      # **configuration**, **deploy**, **undeploy**, and **shutdown**. For
+      # each layer, AWS OpsWorks runs a set of standard recipes for each
+      # event. In addition, you can provide custom recipes for any or all
+      # layers and events. AWS OpsWorks 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.
+      # @return [Types::Recipes]
+      def default_recipes
+        data.default_recipes
+      end
+
+      # A `LayerCustomRecipes` object that specifies the layer's custom
+      # recipes.
+      # @return [Types::Recipes]
+      def custom_recipes
+        data.custom_recipes
+      end
+
+      # Date when the layer was created.
+      # @return [String]
+      def created_at
+        data.created_at
+      end
+
+      # 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.
+      #
+      # <note markdown="1"> We strongly recommend using the default value of `true`, to ensure
+      # that your instances have the latest security updates.
+      #
+      #  </note>
+      # @return [Boolean]
+      def install_updates_on_boot
+        data.install_updates_on_boot
+      end
+
+      # Whether the layer uses Amazon EBS-optimized instances.
+      # @return [Boolean]
+      def use_ebs_optimized_instances
+        data.use_ebs_optimized_instances
+      end
+
+      # A `LifeCycleEventConfiguration` object that specifies the Shutdown
+      # event configuration.
+      # @return [Types::LifecycleEventConfiguration]
+      def lifecycle_event_configuration
+        data.lifecycle_event_configuration
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {Layer}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     layer.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.describe_layers(layer_ids: [@id])
+        @data = resp.layers[0]
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::Layer]
+      #   Returns the data for this {Layer}. Calls
+      #   {Client#describe_layers} if {#data_loaded?} is `false`.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   layer.delete()
+      # @param [Hash] options ({})
+      # @return [EmptyStructure]
+      def delete(options = {})
+        options = options.merge(layer_id: @id)
+        resp = @client.delete_layer(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [Stack, nil]
+      def stack
+        if data.stack_id
+          Stack.new(
+            id: data.stack_id,
+            client: @client
+          )
+        else
+          nil
+        end
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        { id: @id }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_id(args, options)
+        value = args[0] || options.delete(:id)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :id"
+        else
+          msg = "expected :id to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end

data/lib/aws-sdk-opsworks/resource.rb

@@ -0,0 +1,377 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module OpsWorks
+    class Resource
+
+      # @param options ({})
+      # @option options [Client] :client
+      def initialize(options = {})
+        @client = options[:client] || Client.new(options)
+      end
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   stack = ops_works.create_stack({
+      #     name: "String", # required
+      #     region: "String", # required
+      #     vpc_id: "String",
+      #     attributes: {
+      #       "Color" => "String",
+      #     },
+      #     service_role_arn: "String", # required
+      #     default_instance_profile_arn: "String", # required
+      #     default_os: "String",
+      #     hostname_theme: "String",
+      #     default_availability_zone: "String",
+      #     default_subnet_id: "String",
+      #     custom_json: "String",
+      #     configuration_manager: {
+      #       name: "String",
+      #       version: "String",
+      #     },
+      #     chef_configuration: {
+      #       manage_berkshelf: false,
+      #       berkshelf_version: "String",
+      #     },
+      #     use_custom_cookbooks: false,
+      #     use_opsworks_security_groups: false,
+      #     custom_cookbooks_source: {
+      #       type: "git", # accepts git, svn, archive, s3
+      #       url: "String",
+      #       username: "String",
+      #       password: "String",
+      #       ssh_key: "String",
+      #       revision: "String",
+      #     },
+      #     default_ssh_key_name: "String",
+      #     default_root_device_type: "ebs", # accepts ebs, instance-store
+      #     agent_version: "String",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :name
+      #   The stack name.
+      # @option options [required, String] :region
+      #   The stack's AWS region, such as "ap-south-1". For more information
+      #   about Amazon regions, see [Regions and Endpoints][1].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/general/latest/gr/rande.html
+      # @option options [String] :vpc_id
+      #   The ID of the VPC that the stack is to be launched into. The VPC must
+      #   be in the stack's region. All instances are launched into this VPC.
+      #   You cannot change the ID later.
+      #
+      #   * If your account supports EC2-Classic, the default value is `no VPC`.
+      #
+      #   * If your account does not support EC2-Classic, the default value is
+      #     the default VPC for the specified region.
+      #
+      #   If the VPC ID corresponds to a default VPC and you have specified
+      #   either the `DefaultAvailabilityZone` or the `DefaultSubnetId`
+      #   parameter only, AWS OpsWorks infers the value of the other parameter.
+      #   If you specify neither parameter, AWS OpsWorks sets these parameters
+      #   to the first valid Availability Zone for the specified region and the
+      #   corresponding default VPC subnet ID, respectively.
+      #
+      #   If you specify a nondefault VPC ID, note the following:
+      #
+      #   * It must belong to a VPC in your account that is in the specified
+      #     region.
+      #
+      #   * You must specify a value for `DefaultSubnetId`.
+      #
+      #   For more information on how to use AWS OpsWorks with a VPC, see
+      #   [Running a Stack in a VPC][1]. For more information on default VPC and
+      #   EC2-Classic, see [Supported Platforms][2].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html
+      #   [2]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html
+      # @option options [Hash<String,String>] :attributes
+      #   One or more user-defined key-value pairs to be added to the stack
+      #   attributes.
+      # @option options [required, String] :service_role_arn
+      #   The stack's AWS Identity and Access Management (IAM) role, which
+      #   allows AWS OpsWorks to work with AWS resources on your behalf. You
+      #   must set this parameter to the Amazon Resource Name (ARN) for an
+      #   existing IAM role. For more information about IAM ARNs, see [Using
+      #   Identifiers][1].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      # @option options [required, String] :default_instance_profile_arn
+      #   The Amazon Resource Name (ARN) of an IAM profile that is the default
+      #   profile for all of the stack's EC2 instances. For more information
+      #   about IAM ARNs, see [Using Identifiers][1].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      # @option options [String] :default_os
+      #   The stack's default operating system, which is installed on every
+      #   instance unless you specify a different operating system when you
+      #   create the instance. You can specify one of the following.
+      #
+      #   * A supported Linux operating system: An Amazon Linux version, such as
+      #     `Amazon Linux 2016.03`, `Amazon Linux 2015.09`, or `Amazon Linux
+      #     2015.03`.
+      #
+      #   * A supported Ubuntu operating system, such as `Ubuntu 16.04 LTS`,
+      #     `Ubuntu 14.04 LTS`, or `Ubuntu 12.04 LTS`.
+      #
+      #   * `CentOS 7`
+      #
+      #   * `Red Hat Enterprise Linux 7`
+      #
+      #   * A supported Windows operating system, such as `Microsoft Windows
+      #     Server 2012 R2 Base`, `Microsoft Windows Server 2012 R2 with SQL
+      #     Server Express`, `Microsoft Windows Server 2012 R2 with SQL Server
+      #     Standard`, or `Microsoft Windows Server 2012 R2 with SQL Server
+      #     Web`.
+      #
+      #   * A custom AMI: `Custom`. You specify the custom AMI you want to use
+      #     when you create instances. For more information, see [ Using Custom
+      #     AMIs][1].
+      #
+      #   The default option is the current Amazon Linux version. For more
+      #   information on the supported operating systems, see [AWS OpsWorks
+      #   Operating Systems][2].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html
+      #   [2]: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html
+      # @option options [String] :hostname_theme
+      #   The stack's host name theme, with spaces replaced by underscores. The
+      #   theme is used to generate host names for the stack's instances. By
+      #   default, `HostnameTheme` is set to `Layer_Dependent`, which creates
+      #   host names by appending integers to the layer's short name. The other
+      #   themes are:
+      #
+      #   * `Baked_Goods`
+      #
+      #   * `Clouds`
+      #
+      #   * `Europe_Cities`
+      #
+      #   * `Fruits`
+      #
+      #   * `Greek_Deities`
+      #
+      #   * `Legendary_creatures_from_Japan`
+      #
+      #   * `Planets_and_Moons`
+      #
+      #   * `Roman_Deities`
+      #
+      #   * `Scottish_Islands`
+      #
+      #   * `US_Cities`
+      #
+      #   * `Wild_Cats`
+      #
+      #   To obtain a generated host name, call `GetHostNameSuggestion`, which
+      #   returns a host name based on the current theme.
+      # @option options [String] :default_availability_zone
+      #   The stack's default Availability Zone, which must be in the specified
+      #   region. For more information, see [Regions and Endpoints][1]. If you
+      #   also specify a value for `DefaultSubnetId`, the subnet must be in the
+      #   same zone. For more information, see the `VpcId` parameter
+      #   description.
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/general/latest/gr/rande.html
+      # @option options [String] :default_subnet_id
+      #   The stack's default VPC subnet ID. This parameter is required if you
+      #   specify a value for the `VpcId` parameter. All instances are launched
+      #   into this subnet unless you specify otherwise when you create the
+      #   instance. If you also specify a value for `DefaultAvailabilityZone`,
+      #   the subnet must be in that zone. For information on default values and
+      #   when this parameter is required, see the `VpcId` parameter
+      #   description.
+      # @option options [String] :custom_json
+      #   A string that contains user-defined, custom JSON. It can be used to
+      #   override the corresponding default stack configuration attribute
+      #   values or to pass data to recipes. The string should be in the
+      #   following format:
+      #
+      #   `"\{"key1": "value1", "key2": "value2",...\}"`
+      #
+      #   For more information on custom JSON, see [Use Custom JSON to Modify
+      #   the Stack Configuration Attributes][1].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html
+      # @option options [Types::StackConfigurationManager] :configuration_manager
+      #   The configuration manager. When you create a stack we recommend that
+      #   you use the configuration manager to specify the Chef version: 12,
+      #   11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The
+      #   default value for Linux stacks is currently 11.4.
+      # @option options [Types::ChefConfiguration] :chef_configuration
+      #   A `ChefConfiguration` object that specifies whether to enable
+      #   Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more
+      #   information, see [Create a New Stack][1].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html
+      # @option options [Boolean] :use_custom_cookbooks
+      #   Whether the stack uses custom cookbooks.
+      # @option options [Boolean] :use_opsworks_security_groups
+      #   Whether to associate the AWS OpsWorks built-in security groups with
+      #   the stack's layers.
+      #
+      #   AWS OpsWorks provides a standard set of built-in security groups, one
+      #   for each layer, which are associated with layers by default. With
+      #   `UseOpsworksSecurityGroups` you can instead provide your own custom
+      #   security groups. `UseOpsworksSecurityGroups` has the following
+      #   settings:
+      #
+      #   * True - AWS OpsWorks automatically associates the appropriate
+      #     built-in security group with each layer (default setting). You can
+      #     associate additional security groups with a layer after you create
+      #     it, but you cannot delete the built-in security group.
+      #
+      #   * False - AWS OpsWorks does not associate built-in security groups
+      #     with layers. You must create appropriate EC2 security groups and
+      #     associate a security group with each layer that you create. However,
+      #     you can still manually associate a built-in security group with a
+      #     layer on creation; custom security groups are required only for
+      #     those layers that need custom settings.
+      #
+      #   For more information, see [Create a New Stack][1].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html
+      # @option options [Types::Source] :custom_cookbooks_source
+      #   Contains the information required to retrieve an app or cookbook from
+      #   a repository. For more information, see [Creating Apps][1] or [Custom
+      #   Recipes and Cookbooks][2].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html
+      #   [2]: http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html
+      # @option options [String] :default_ssh_key_name
+      #   A default Amazon EC2 key pair name. The default value is none. If you
+      #   specify a key pair name, AWS OpsWorks installs the public key on the
+      #   instance and you can use the private key with an SSH client to log in
+      #   to the instance. For more information, see [ Using SSH to Communicate
+      #   with an Instance][1] and [ Managing SSH Access][2]. You can override
+      #   this setting by specifying a different key pair, or no key pair, when
+      #   you [ create an instance][3].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html
+      #   [2]: http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html
+      #   [3]: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html
+      # @option options [String] :default_root_device_type
+      #   The default root device type. This value is the default for all
+      #   instances in the stack, but you can override it when you create an
+      #   instance. The default option is `instance-store`. For more
+      #   information, see [Storage for the Root Device][1].
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device
+      # @option options [String] :agent_version
+      #   The default AWS OpsWorks agent version. You have the following
+      #   options:
+      #
+      #   * Auto-update - Set this parameter to `LATEST`. AWS OpsWorks
+      #     automatically installs new agent versions on the stack's instances
+      #     as soon as they are available.
+      #
+      #   * Fixed version - Set this parameter to your preferred agent version.
+      #     To update the agent version, you must edit the stack configuration
+      #     and specify a new version. AWS OpsWorks then automatically installs
+      #     that version on the stack's instances.
+      #
+      #   The default setting is the most recent release of the agent. To
+      #   specify an agent version, you must use the complete version number,
+      #   not the abbreviated number shown on the console. For a list of
+      #   available agent version numbers, call DescribeAgentVersions.
+      #
+      #   <note markdown="1"> You can also specify an agent version when you create or update an
+      #   instance, which overrides the stack's default setting.
+      #
+      #    </note>
+      # @return [Stack]
+      def create_stack(options = {})
+        resp = @client.create_stack(options)
+        Stack.new(
+          id: resp.data.stack_id,
+          client: @client
+        )
+      end
+
+      # @!group Associations
+
+      # @param [String] id
+      # @return [Layer]
+      def layer(id)
+        Layer.new(
+          id: id,
+          client: @client
+        )
+      end
+
+      # @param [String] id
+      # @return [Stack]
+      def stack(id)
+        Stack.new(
+          id: id,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   stacks = ops_works.stacks({
+      #     stack_ids: ["String"],
+      #   })
+      # @param [Hash] options ({})
+      # @option options [Array<String>] :stack_ids
+      #   An array of stack IDs that specify the stacks to be described. If you
+      #   omit this parameter, `DescribeStacks` returns a description of every
+      #   stack.
+      # @return [Stack::Collection]
+      def stacks(options = {})
+        batches = Enumerator.new do |y|
+          batch = []
+          resp = @client.describe_stacks(options)
+          resp.data.stacks.each do |s|
+            batch << Stack.new(
+              id: s.stack_id,
+              data: s,
+              client: @client
+            )
+          end
+          y.yield(batch)
+        end
+        Stack::Collection.new(batches)
+      end
+
+    end
+  end
+end