aws-sdk-rds 1.0.0.rc1

data/lib/aws-sdk-rds/db_snapshot.rb

@@ -0,0 +1,714 @@
+# 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 RDS
+    class DBSnapshot
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(instance_id, snapshot_id, options = {})
+      #   @param [String] instance_id
+      #   @param [String] snapshot_id
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :instance_id
+      #   @option options [required, String] :snapshot_id
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @instance_id = extract_instance_id(args, options)
+        @snapshot_id = extract_snapshot_id(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def instance_id
+        @instance_id
+      end
+      alias :db_instance_identifier :instance_id
+
+      # @return [String]
+      def snapshot_id
+        @snapshot_id
+      end
+      alias :db_snapshot_identifier :snapshot_id
+
+      # Provides the time when the snapshot was taken, in Universal
+      # Coordinated Time (UTC).
+      # @return [Time]
+      def snapshot_create_time
+        data.snapshot_create_time
+      end
+
+      # Specifies the name of the database engine.
+      # @return [String]
+      def engine
+        data.engine
+      end
+
+      # Specifies the allocated storage size in gigabytes (GB).
+      # @return [Integer]
+      def allocated_storage
+        data.allocated_storage
+      end
+
+      # Specifies the status of this DB snapshot.
+      # @return [String]
+      def status
+        data.status
+      end
+
+      # Specifies the port that the database engine was listening on at the
+      # time of the snapshot.
+      # @return [Integer]
+      def port
+        data.port
+      end
+
+      # Specifies the name of the Availability Zone the DB instance was
+      # located in at the time of the DB snapshot.
+      # @return [String]
+      def availability_zone
+        data.availability_zone
+      end
+
+      # Provides the VPC ID associated with the DB snapshot.
+      # @return [String]
+      def vpc_id
+        data.vpc_id
+      end
+
+      # Specifies the time when the snapshot was taken, in Universal
+      # Coordinated Time (UTC).
+      # @return [Time]
+      def instance_create_time
+        data.instance_create_time
+      end
+
+      # Provides the master username for the DB snapshot.
+      # @return [String]
+      def master_username
+        data.master_username
+      end
+
+      # Specifies the version of the database engine.
+      # @return [String]
+      def engine_version
+        data.engine_version
+      end
+
+      # License model information for the restored DB instance.
+      # @return [String]
+      def license_model
+        data.license_model
+      end
+
+      # Provides the type of the DB snapshot.
+      # @return [String]
+      def snapshot_type
+        data.snapshot_type
+      end
+
+      # Specifies the Provisioned IOPS (I/O operations per second) value of
+      # the DB instance at the time of the snapshot.
+      # @return [Integer]
+      def iops
+        data.iops
+      end
+
+      # Provides the option group name for the DB snapshot.
+      # @return [String]
+      def option_group_name
+        data.option_group_name
+      end
+
+      # The percentage of the estimated data that has been transferred.
+      # @return [Integer]
+      def percent_progress
+        data.percent_progress
+      end
+
+      # The region that the DB snapshot was created in or copied from.
+      # @return [String]
+      def source_region
+        data.source_region
+      end
+
+      # The DB snapshot Arn that the DB snapshot was copied from. It only has
+      # value in case of cross customer or cross region copy.
+      # @return [String]
+      def source_db_snapshot_identifier
+        data.source_db_snapshot_identifier
+      end
+
+      # Specifies the storage type associated with DB snapshot.
+      # @return [String]
+      def storage_type
+        data.storage_type
+      end
+
+      # The ARN from the key store with which to associate the instance for
+      # TDE encryption.
+      # @return [String]
+      def tde_credential_arn
+        data.tde_credential_arn
+      end
+
+      # Specifies whether the DB snapshot is encrypted.
+      # @return [Boolean]
+      def encrypted
+        data.encrypted
+      end
+
+      # If `Encrypted` is true, the KMS key identifier for the encrypted DB
+      # snapshot.
+      # @return [String]
+      def kms_key_id
+        data.kms_key_id
+      end
+
+      # The Amazon Resource Name (ARN) for the DB snapshot.
+      # @return [String]
+      def db_snapshot_arn
+        data.db_snapshot_arn
+      end
+
+      # The time zone of the DB snapshot. In most cases, the `Timezone`
+      # element is empty. `Timezone` content appears only for snapshots taken
+      # from Microsoft SQL Server DB instances that were created with a time
+      # zone specified.
+      # @return [String]
+      def timezone
+        data.timezone
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {DBSnapshot}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     db_snapshot.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.describe_db_snapshots(db_snapshot_identifier: @snapshot_id)
+        @data = resp.dbsnapshots[0]
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::DBSnapshot]
+      #   Returns the data for this {DBSnapshot}. Calls
+      #   {Client#describe_db_snapshots} 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
+      #
+      #   dbsnapshot = db_snapshot.create({
+      #     tags: [
+      #       {
+      #         key: "String",
+      #         value: "String",
+      #       },
+      #     ],
+      #   })
+      # @param [Hash] options ({})
+      # @option options [Array<Types::Tag>] :tags
+      #   A list of tags.
+      # @return [DBSnapshot]
+      def create(options = {})
+        options = options.merge(
+          db_instance_identifier: @instance_id,
+          db_snapshot_identifier: @snapshot_id
+        )
+        resp = @client.create_db_snapshot(options)
+        DBSnapshot.new(
+          instance_id: resp.data.db_snapshot.db_instance_identifier,
+          snapshot_id: resp.data.db_snapshot.db_snapshot_identifier,
+          data: resp.data.db_snapshot,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   dbsnapshot = db_snapshot.copy({
+      #     target_db_snapshot_identifier: "String", # required
+      #     kms_key_id: "String",
+      #     tags: [
+      #       {
+      #         key: "String",
+      #         value: "String",
+      #       },
+      #     ],
+      #     copy_tags: false,
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :target_db_snapshot_identifier
+      #   The identifier for the copied snapshot.
+      #
+      #   Constraints:
+      #
+      #   * Cannot be null, empty, or blank
+      #
+      #   * Must contain from 1 to 255 alphanumeric characters or hyphens
+      #
+      #   * First character must be a letter
+      #
+      #   * Cannot end with a hyphen or contain two consecutive hyphens
+      #
+      #   Example: `my-db-snapshot`
+      # @option options [String] :kms_key_id
+      #   The AWS Key Management Service (AWS KMS) key identifier for an
+      #   encrypted DB snapshot. The KMS key identifier is the Amazon Resource
+      #   Name (ARN) or the KMS key alias for the KMS encryption key.
+      #
+      #   If you copy an unencrypted DB snapshot and specify a value for the
+      #   `KmsKeyId` parameter, Amazon RDS encrypts the target DB snapshot using
+      #   the specified KMS encryption key.
+      #
+      #   If you copy an encrypted DB snapshot from your AWS account, you can
+      #   specify a value for `KmsKeyId` to encrypt the copy with a new KMS
+      #   encryption key. If you don't specify a value for `KmsKeyId` then the
+      #   copy of the DB snapshot is encrypted with the same KMS key as the
+      #   source DB snapshot.
+      #
+      #   If you copy an encrypted DB snapshot that is shared from another AWS
+      #   account, then you must specify a value for `KmsKeyId`.
+      # @option options [Array<Types::Tag>] :tags
+      #   A list of tags.
+      # @option options [Boolean] :copy_tags
+      #   True to copy all tags from the source DB snapshot to the target DB
+      #   snapshot; otherwise false. The default is false.
+      # @return [DBSnapshot]
+      def copy(options = {})
+        options = options.merge(source_db_snapshot_identifier: @snapshot_id)
+        resp = @client.copy_db_snapshot(options)
+        DBSnapshot.new(
+          instance_id: resp.data.db_snapshot.db_instance_identifier,
+          snapshot_id: resp.data.db_snapshot.db_snapshot_identifier,
+          data: resp.data.db_snapshot,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   dbsnapshot = db_snapshot.delete()
+      # @param [Hash] options ({})
+      # @return [DBSnapshot]
+      def delete(options = {})
+        options = options.merge(db_snapshot_identifier: @snapshot_id)
+        resp = @client.delete_db_snapshot(options)
+        DBSnapshot.new(
+          instance_id: resp.data.db_snapshot.db_instance_identifier,
+          snapshot_id: resp.data.db_snapshot.db_snapshot_identifier,
+          data: resp.data.db_snapshot,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   dbinstance = db_snapshot.restore({
+      #     db_instance_identifier: "String", # required
+      #     db_instance_class: "String",
+      #     port: 1,
+      #     availability_zone: "String",
+      #     db_subnet_group_name: "String",
+      #     multi_az: false,
+      #     publicly_accessible: false,
+      #     auto_minor_version_upgrade: false,
+      #     license_model: "String",
+      #     db_name: "String",
+      #     engine: "String",
+      #     iops: 1,
+      #     option_group_name: "String",
+      #     tags: [
+      #       {
+      #         key: "String",
+      #         value: "String",
+      #       },
+      #     ],
+      #     storage_type: "String",
+      #     tde_credential_arn: "String",
+      #     tde_credential_password: "String",
+      #     domain: "String",
+      #     copy_tags_to_snapshot: false,
+      #     domain_iam_role_name: "String",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :db_instance_identifier
+      #   Name of the DB instance to create from the DB snapshot. This parameter
+      #   isn't case-sensitive.
+      #
+      #   Constraints:
+      #
+      #   * Must contain from 1 to 63 alphanumeric characters or hyphens (1 to
+      #     15 for SQL Server)
+      #
+      #   * First character must be a letter
+      #
+      #   * Cannot end with a hyphen or contain two consecutive hyphens
+      #
+      #   Example: `my-snapshot-id`
+      # @option options [String] :db_instance_class
+      #   The compute and memory capacity of the Amazon RDS DB instance.
+      #
+      #   Valid Values: `db.t1.micro | db.m1.small | db.m1.medium | db.m1.large
+      #   | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium |
+      #   db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large |
+      #   db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge |
+      #   db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
+      #   db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium |
+      #   db.t2.large`
+      # @option options [Integer] :port
+      #   The port number on which the database accepts connections.
+      #
+      #   Default: The same port as the original DB instance
+      #
+      #   Constraints: Value must be `1150-65535`
+      # @option options [String] :availability_zone
+      #   The EC2 Availability Zone that the database instance will be created
+      #   in.
+      #
+      #   Default: A random, system-chosen Availability Zone.
+      #
+      #   Constraint: You cannot specify the AvailabilityZone parameter if the
+      #   MultiAZ parameter is set to `true`.
+      #
+      #   Example: `us-east-1a`
+      # @option options [String] :db_subnet_group_name
+      #   The DB subnet group name to use for the new instance.
+      #
+      #   Constraints: Must contain no more than 255 alphanumeric characters,
+      #   periods, underscores, spaces, or hyphens. Must not be default.
+      #
+      #   Example: `mySubnetgroup`
+      # @option options [Boolean] :multi_az
+      #   Specifies if the DB instance is a Multi-AZ deployment.
+      #
+      #   Constraint: You cannot specify the AvailabilityZone parameter if the
+      #   MultiAZ parameter is set to `true`.
+      # @option options [Boolean] :publicly_accessible
+      #   Specifies the accessibility options for the DB instance. A value of
+      #   true specifies an Internet-facing instance with a publicly resolvable
+      #   DNS name, which resolves to a public IP address. A value of false
+      #   specifies an internal instance with a DNS name that resolves to a
+      #   private IP address.
+      #
+      #   Default: The default behavior varies depending on whether a VPC has
+      #   been requested or not. The following list shows the default behavior
+      #   in each case.
+      #
+      #   * **Default VPC:** true
+      #
+      #   * **VPC:** false
+      #
+      #   If no DB subnet group has been specified as part of the request and
+      #   the PubliclyAccessible value has not been set, the DB instance will be
+      #   publicly accessible. If a specific DB subnet group has been specified
+      #   as part of the request and the PubliclyAccessible value has not been
+      #   set, the DB instance will be private.
+      # @option options [Boolean] :auto_minor_version_upgrade
+      #   Indicates that minor version upgrades will be applied automatically to
+      #   the DB instance during the maintenance window.
+      # @option options [String] :license_model
+      #   License model information for the restored DB instance.
+      #
+      #   Default: Same as source.
+      #
+      #   Valid values: `license-included` \| `bring-your-own-license` \|
+      #   `general-public-license`
+      # @option options [String] :db_name
+      #   The database name for the restored DB instance.
+      #
+      #   <note markdown="1"> This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB
+      #   engines.
+      #
+      #    </note>
+      # @option options [String] :engine
+      #   The database engine to use for the new instance.
+      #
+      #   Default: The same as source
+      #
+      #   Constraint: Must be compatible with the engine of the source
+      #
+      #   Valid Values: `MySQL` \| `mariadb` \| `oracle-se1` \| `oracle-se` \|
+      #   `oracle-ee` \| `sqlserver-ee` \| `sqlserver-se` \| `sqlserver-ex` \|
+      #   `sqlserver-web` \| `postgres` \| `aurora`
+      # @option options [Integer] :iops
+      #   Specifies the amount of provisioned IOPS for the DB instance,
+      #   expressed in I/O operations per second. If this parameter is not
+      #   specified, the IOPS value will be taken from the backup. If this
+      #   parameter is set to 0, the new instance will be converted to a
+      #   non-PIOPS instance, which will take additional time, though your DB
+      #   instance will be available for connections before the conversion
+      #   starts.
+      #
+      #   Constraints: Must be an integer greater than 1000.
+      #
+      #   **SQL Server**
+      #
+      #   Setting the IOPS value for the SQL Server database engine is not
+      #   supported.
+      # @option options [String] :option_group_name
+      #   The name of the option group to be used for the restored DB instance.
+      #
+      #   Permanent options, such as the TDE option for Oracle Advanced Security
+      #   TDE, cannot be removed from an option group, and that option group
+      #   cannot be removed from a DB instance once it is associated with a DB
+      #   instance
+      # @option options [Array<Types::Tag>] :tags
+      #   A list of tags.
+      # @option options [String] :storage_type
+      #   Specifies the storage type to be associated with the DB instance.
+      #
+      #   Valid values: `standard | gp2 | io1`
+      #
+      #   If you specify `io1`, you must also include a value for the `Iops`
+      #   parameter.
+      #
+      #   Default: `io1` if the `Iops` parameter is specified; otherwise
+      #   `standard`
+      # @option options [String] :tde_credential_arn
+      #   The ARN from the Key Store with which to associate the instance for
+      #   TDE encryption.
+      # @option options [String] :tde_credential_password
+      #   The password for the given ARN from the Key Store in order to access
+      #   the device.
+      # @option options [String] :domain
+      #   Specify the Active Directory Domain to restore the instance in.
+      # @option options [Boolean] :copy_tags_to_snapshot
+      #   True to copy all tags from the restored DB instance to snapshots of
+      #   the DB instance; otherwise false. The default is false.
+      # @option options [String] :domain_iam_role_name
+      #   Specify the name of the IAM role to be used when making API calls to
+      #   the Directory Service.
+      # @return [DBInstance]
+      def restore(options = {})
+        options = options.merge(db_snapshot_identifier: @snapshot_id)
+        resp = @client.restore_db_instance_from_db_snapshot(options)
+        DBInstance.new(
+          id: resp.data.db_instance.db_instance_identifier,
+          data: resp.data.db_instance,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   eventsubscription = db_snapshot.subscribe_to({
+      #     subscription_name: "String", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :subscription_name
+      #   The name of the RDS event notification subscription you want to add a
+      #   source identifier to.
+      # @return [EventSubscription]
+      def subscribe_to(options = {})
+        options = options.merge(source_identifier: @snapshot_id)
+        resp = @client.add_source_identifier_to_subscription(options)
+        EventSubscription.new(
+          name: resp.data.event_subscription.cust_subscription_id,
+          data: resp.data.event_subscription,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   eventsubscription = db_snapshot.unsubscribe_from({
+      #     subscription_name: "String", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :subscription_name
+      #   The name of the RDS event notification subscription you want to remove
+      #   a source identifier from.
+      # @return [EventSubscription]
+      def unsubscribe_from(options = {})
+        options = options.merge(source_identifier: @snapshot_id)
+        resp = @client.remove_source_identifier_from_subscription(options)
+        EventSubscription.new(
+          name: resp.data.event_subscription.cust_subscription_id,
+          data: resp.data.event_subscription,
+          client: @client
+        )
+      end
+
+      # @!group Associations
+
+      # @example Request syntax with placeholder values
+      #
+      #   attributes = db_snapshot.attributes()
+      # @param [Hash] options ({})
+      # @return [DBSnapshotAttribute::Collection]
+      def attributes(options = {})
+        batches = Enumerator.new do |y|
+          batch = []
+          options = options.merge(db_snapshot_identifier: @snapshot_id)
+          resp = @client.describe_db_snapshot_attributes(options)
+          resp.data.db_snapshot_attributes_result.db_snapshot_attributes.each do |d|
+            batch << DBSnapshotAttribute.new(
+              snapshot_id: @snapshot_id,
+              name: d.attribute_name,
+              data: d,
+              client: @client
+            )
+          end
+          y.yield(batch)
+        end
+        DBSnapshotAttribute::Collection.new(batches)
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   events = db_snapshot.events({
+      #     start_time: Time.now,
+      #     end_time: Time.now,
+      #     duration: 1,
+      #     event_categories: ["String"],
+      #     filters: [
+      #       {
+      #         name: "String", # required
+      #         values: ["String"], # required
+      #       },
+      #     ],
+      #   })
+      # @param [Hash] options ({})
+      # @option options [Time,DateTime,Date,Integer,String] :start_time
+      #   The beginning of the time interval to retrieve events for, specified
+      #   in ISO 8601 format. For more information about ISO 8601, go to the
+      #   [ISO8601 Wikipedia page.][1]
+      #
+      #   Example: 2009-07-08T18:00Z
+      #
+      #
+      #
+      #   [1]: http://en.wikipedia.org/wiki/ISO_8601
+      # @option options [Time,DateTime,Date,Integer,String] :end_time
+      #   The end of the time interval for which to retrieve events, specified
+      #   in ISO 8601 format. For more information about ISO 8601, go to the
+      #   [ISO8601 Wikipedia page.][1]
+      #
+      #   Example: 2009-07-08T18:00Z
+      #
+      #
+      #
+      #   [1]: http://en.wikipedia.org/wiki/ISO_8601
+      # @option options [Integer] :duration
+      #   The number of minutes to retrieve events for.
+      #
+      #   Default: 60
+      # @option options [Array<String>] :event_categories
+      #   A list of event categories that trigger notifications for a event
+      #   notification subscription.
+      # @option options [Array<Types::Filter>] :filters
+      #   This parameter is not currently supported.
+      # @return [Event::Collection]
+      def events(options = {})
+        batches = Enumerator.new do |y|
+          options = options.merge(
+            source_type: "db-snapshot",
+            source_identifier: @snapshot_id
+          )
+          resp = @client.describe_events(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.events.each do |e|
+              batch << Event.new(
+                source_id: e.source_identifier,
+                date: e.date,
+                data: e,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        Event::Collection.new(batches)
+      end
+
+      # @return [DBInstance]
+      def instance
+        DBInstance.new(
+          id: @instance_id,
+          client: @client
+        )
+      end
+
+      # @return [OptionGroup, nil]
+      def option_group
+        if data.db_snapshot.option_group_name
+          OptionGroup.new(
+            name: data.db_snapshot.option_group_name,
+            client: @client
+          )
+        else
+          nil
+        end
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        {
+          instance_id: @instance_id,
+          snapshot_id: @snapshot_id
+        }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_instance_id(args, options)
+        value = args[0] || options.delete(:instance_id)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :instance_id"
+        else
+          msg = "expected :instance_id to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_snapshot_id(args, options)
+        value = args[1] || options.delete(:snapshot_id)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :snapshot_id"
+        else
+          msg = "expected :snapshot_id to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end