aws-sdk-docdb 1.29.0 → 1.30.0

data/lib/aws-sdk-docdb/types.rb

@@ -10,6 +10,58 @@
 module Aws::DocDB
   module Types
 
+    # Represents the input to AddSourceIdentifierToSubscription.
+    #
+    # @note When making an API call, you may pass AddSourceIdentifierToSubscriptionMessage
+    #   data as a hash:
+    #
+    #       {
+    #         subscription_name: "String", # required
+    #         source_identifier: "String", # required
+    #       }
+    #
+    # @!attribute [rw] subscription_name
+    #   The name of the Amazon DocumentDB event notification subscription
+    #   that you want to add a source identifier to.
+    #   @return [String]
+    #
+    # @!attribute [rw] source_identifier
+    #   The identifier of the event source to be added:
+    #
+    #   * If the source type is an instance, a `DBInstanceIdentifier` must
+    #     be provided.
+    #
+    #   * If the source type is a security group, a `DBSecurityGroupName`
+    #     must be provided.
+    #
+    #   * If the source type is a parameter group, a `DBParameterGroupName`
+    #     must be provided.
+    #
+    #   * If the source type is a snapshot, a `DBSnapshotIdentifier` must be
+    #     provided.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddSourceIdentifierToSubscriptionMessage AWS API Documentation
+    #
+    class AddSourceIdentifierToSubscriptionMessage < Struct.new(
+      :subscription_name,
+      :source_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] event_subscription
+    #   Detailed information about an event to which you have subscribed.
+    #   @return [Types::EventSubscription]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddSourceIdentifierToSubscriptionResult AWS API Documentation
+    #
+    class AddSourceIdentifierToSubscriptionResult < Struct.new(
+      :event_subscription)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Represents the input to AddTagsToResource.
     #
     # @note When making an API call, you may pass AddTagsToResourceMessage
@@ -1047,6 +1099,112 @@ module Aws::DocDB
       include Aws::Structure
     end
 
+    # Represents the input to CreateEventSubscription.
+    #
+    # @note When making an API call, you may pass CreateEventSubscriptionMessage
+    #   data as a hash:
+    #
+    #       {
+    #         subscription_name: "String", # required
+    #         sns_topic_arn: "String", # required
+    #         source_type: "String",
+    #         event_categories: ["String"],
+    #         source_ids: ["String"],
+    #         enabled: false,
+    #         tags: [
+    #           {
+    #             key: "String",
+    #             value: "String",
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] subscription_name
+    #   The name of the subscription.
+    #
+    #   Constraints: The name must be fewer than 255 characters.
+    #   @return [String]
+    #
+    # @!attribute [rw] sns_topic_arn
+    #   The Amazon Resource Name (ARN) of the SNS topic created for event
+    #   notification. Amazon SNS creates the ARN when you create a topic and
+    #   subscribe to it.
+    #   @return [String]
+    #
+    # @!attribute [rw] source_type
+    #   The type of source that is generating the events. For example, if
+    #   you want to be notified of events generated by an instance, you
+    #   would set this parameter to `db-instance`. If this value is not
+    #   specified, all events are returned.
+    #
+    #   Valid values: `db-instance`, `db-cluster`, `db-parameter-group`,
+    #   `db-security-group`, `db-snapshot`, `db-cluster-snapshot`
+    #   @return [String]
+    #
+    # @!attribute [rw] event_categories
+    #   A list of event categories for a `SourceType` that you want to
+    #   subscribe to.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] source_ids
+    #   The list of identifiers of the event sources for which events are
+    #   returned. If not specified, then all sources are included in the
+    #   response. An identifier must begin with a letter and must contain
+    #   only ASCII letters, digits, and hyphens; it can't end with a hyphen
+    #   or contain two consecutive hyphens.
+    #
+    #   Constraints:
+    #
+    #   * If `SourceIds` are provided, `SourceType` must also be provided.
+    #
+    #   * If the source type is an instance, a `DBInstanceIdentifier` must
+    #     be provided.
+    #
+    #   * If the source type is a security group, a `DBSecurityGroupName`
+    #     must be provided.
+    #
+    #   * If the source type is a parameter group, a `DBParameterGroupName`
+    #     must be provided.
+    #
+    #   * If the source type is a snapshot, a `DBSnapshotIdentifier` must be
+    #     provided.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] enabled
+    #   A Boolean value; set to `true` to activate the subscription, set to
+    #   `false` to create the subscription but not active it.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] tags
+    #   The tags to be assigned to the event subscription.
+    #   @return [Array<Types::Tag>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateEventSubscriptionMessage AWS API Documentation
+    #
+    class CreateEventSubscriptionMessage < Struct.new(
+      :subscription_name,
+      :sns_topic_arn,
+      :source_type,
+      :event_categories,
+      :source_ids,
+      :enabled,
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] event_subscription
+    #   Detailed information about an event to which you have subscribed.
+    #   @return [Types::EventSubscription]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateEventSubscriptionResult AWS API Documentation
+    #
+    class CreateEventSubscriptionResult < Struct.new(
+      :event_subscription)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Detailed information about a cluster.
     #
     # @!attribute [rw] availability_zones
@@ -2290,6 +2448,40 @@ module Aws::DocDB
       include Aws::Structure
     end
 
+    # Represents the input to DeleteEventSubscription.
+    #
+    # @note When making an API call, you may pass DeleteEventSubscriptionMessage
+    #   data as a hash:
+    #
+    #       {
+    #         subscription_name: "String", # required
+    #       }
+    #
+    # @!attribute [rw] subscription_name
+    #   The name of the Amazon DocumentDB event notification subscription
+    #   that you want to delete.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteEventSubscriptionMessage AWS API Documentation
+    #
+    class DeleteEventSubscriptionMessage < Struct.new(
+      :subscription_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] event_subscription
+    #   Detailed information about an event to which you have subscribed.
+    #   @return [Types::EventSubscription]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteEventSubscriptionResult AWS API Documentation
+    #
+    class DeleteEventSubscriptionResult < Struct.new(
+      :event_subscription)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeCertificatesMessage
     #   data as a hash:
     #
@@ -3036,6 +3228,60 @@ module Aws::DocDB
       include Aws::Structure
     end
 
+    # Represents the input to DescribeEventSubscriptions.
+    #
+    # @note When making an API call, you may pass DescribeEventSubscriptionsMessage
+    #   data as a hash:
+    #
+    #       {
+    #         subscription_name: "String",
+    #         filters: [
+    #           {
+    #             name: "String", # required
+    #             values: ["String"], # required
+    #           },
+    #         ],
+    #         max_records: 1,
+    #         marker: "String",
+    #       }
+    #
+    # @!attribute [rw] subscription_name
+    #   The name of the Amazon DocumentDB event notification subscription
+    #   that you want to describe.
+    #   @return [String]
+    #
+    # @!attribute [rw] filters
+    #   This parameter is not currently supported.
+    #   @return [Array<Types::Filter>]
+    #
+    # @!attribute [rw] max_records
+    #   The maximum number of records to include in the response. If more
+    #   records exist than the specified `MaxRecords` value, a pagination
+    #   token (marker) is included in the response so that the remaining
+    #   results can be retrieved.
+    #
+    #   Default: 100
+    #
+    #   Constraints: Minimum 20, maximum 100.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] marker
+    #   An optional pagination token provided by a previous request. If this
+    #   parameter is specified, the response includes only records beyond
+    #   the marker, up to the value specified by `MaxRecords`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventSubscriptionsMessage AWS API Documentation
+    #
+    class DescribeEventSubscriptionsMessage < Struct.new(
+      :subscription_name,
+      :filters,
+      :max_records,
+      :marker)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Represents the input to DescribeEvents.
     #
     # @note When making an API call, you may pass DescribeEventsMessage
@@ -3421,6 +3667,109 @@ module Aws::DocDB
       include Aws::Structure
     end
 
+    # Detailed information about an event to which you have subscribed.
+    #
+    # @!attribute [rw] customer_aws_id
+    #   The AWS customer account that is associated with the Amazon
+    #   DocumentDB event notification subscription.
+    #   @return [String]
+    #
+    # @!attribute [rw] cust_subscription_id
+    #   The Amazon DocumentDB event notification subscription ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] sns_topic_arn
+    #   The topic ARN of the Amazon DocumentDB event notification
+    #   subscription.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the Amazon DocumentDB event notification subscription.
+    #
+    #   Constraints:
+    #
+    #   Can be one of the following: `creating`, `modifying`, `deleting`,
+    #   `active`, `no-permission`, `topic-not-exist`
+    #
+    #   The `no-permission` status indicates that Amazon DocumentDB no
+    #   longer has permission to post to the SNS topic. The
+    #   `topic-not-exist` status indicates that the topic was deleted after
+    #   the subscription was created.
+    #   @return [String]
+    #
+    # @!attribute [rw] subscription_creation_time
+    #   The time at which the Amazon DocumentDB event notification
+    #   subscription was created.
+    #   @return [String]
+    #
+    # @!attribute [rw] source_type
+    #   The source type for the Amazon DocumentDB event notification
+    #   subscription.
+    #   @return [String]
+    #
+    # @!attribute [rw] source_ids_list
+    #   A list of source IDs for the Amazon DocumentDB event notification
+    #   subscription.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] event_categories_list
+    #   A list of event categories for the Amazon DocumentDB event
+    #   notification subscription.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] enabled
+    #   A Boolean value indicating whether the subscription is enabled. A
+    #   value of `true` indicates that the subscription is enabled.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] event_subscription_arn
+    #   The Amazon Resource Name (ARN) for the event subscription.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EventSubscription AWS API Documentation
+    #
+    class EventSubscription < Struct.new(
+      :customer_aws_id,
+      :cust_subscription_id,
+      :sns_topic_arn,
+      :status,
+      :subscription_creation_time,
+      :source_type,
+      :source_ids_list,
+      :event_categories_list,
+      :enabled,
+      :event_subscription_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # You have reached the maximum number of event subscriptions.
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EventSubscriptionQuotaExceededFault AWS API Documentation
+    #
+    class EventSubscriptionQuotaExceededFault < Aws::EmptyStructure; end
+
+    # Represents the output of DescribeEventSubscriptions.
+    #
+    # @!attribute [rw] marker
+    #   An optional pagination token provided by a previous request. If this
+    #   parameter is specified, the response includes only records beyond
+    #   the marker, up to the value specified by `MaxRecords`.
+    #   @return [String]
+    #
+    # @!attribute [rw] event_subscriptions_list
+    #   A list of event subscriptions.
+    #   @return [Array<Types::EventSubscription>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EventSubscriptionsMessage AWS API Documentation
+    #
+    class EventSubscriptionsMessage < Struct.new(
+      :marker,
+      :event_subscriptions_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Represents the output of DescribeEvents.
     #
     # @!attribute [rw] marker
@@ -3599,6 +3948,13 @@ module Aws::DocDB
     #
     class InvalidDBSubnetStateFault < Aws::EmptyStructure; end
 
+    # Someone else might be modifying a subscription. Wait a few seconds,
+    # and try again.
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidEventSubscriptionStateFault AWS API Documentation
+    #
+    class InvalidEventSubscriptionStateFault < Aws::EmptyStructure; end
+
     # You cannot restore from a virtual private cloud (VPC) backup to a
     # non-VPC DB instance.
     #
@@ -4159,6 +4515,72 @@ module Aws::DocDB
       include Aws::Structure
     end
 
+    # Represents the input to ModifyEventSubscription.
+    #
+    # @note When making an API call, you may pass ModifyEventSubscriptionMessage
+    #   data as a hash:
+    #
+    #       {
+    #         subscription_name: "String", # required
+    #         sns_topic_arn: "String",
+    #         source_type: "String",
+    #         event_categories: ["String"],
+    #         enabled: false,
+    #       }
+    #
+    # @!attribute [rw] subscription_name
+    #   The name of the Amazon DocumentDB event notification subscription.
+    #   @return [String]
+    #
+    # @!attribute [rw] sns_topic_arn
+    #   The Amazon Resource Name (ARN) of the SNS topic created for event
+    #   notification. The ARN is created by Amazon SNS when you create a
+    #   topic and subscribe to it.
+    #   @return [String]
+    #
+    # @!attribute [rw] source_type
+    #   The type of source that is generating the events. For example, if
+    #   you want to be notified of events generated by an instance, set this
+    #   parameter to `db-instance`. If this value is not specified, all
+    #   events are returned.
+    #
+    #   Valid values: `db-instance`, `db-parameter-group`,
+    #   `db-security-group`, `db-snapshot`
+    #   @return [String]
+    #
+    # @!attribute [rw] event_categories
+    #   A list of event categories for a `SourceType` that you want to
+    #   subscribe to.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] enabled
+    #   A Boolean value; set to `true` to activate the subscription.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyEventSubscriptionMessage AWS API Documentation
+    #
+    class ModifyEventSubscriptionMessage < Struct.new(
+      :subscription_name,
+      :sns_topic_arn,
+      :source_type,
+      :event_categories,
+      :enabled)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] event_subscription
+    #   Detailed information about an event to which you have subscribed.
+    #   @return [Types::EventSubscription]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyEventSubscriptionResult AWS API Documentation
+    #
+    class ModifyEventSubscriptionResult < Struct.new(
+      :event_subscription)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The options that are available for an instance.
     #
     # @!attribute [rw] engine
@@ -4530,6 +4952,48 @@ module Aws::DocDB
       include Aws::Structure
     end
 
+    # Represents the input to RemoveSourceIdentifierFromSubscription.
+    #
+    # @note When making an API call, you may pass RemoveSourceIdentifierFromSubscriptionMessage
+    #   data as a hash:
+    #
+    #       {
+    #         subscription_name: "String", # required
+    #         source_identifier: "String", # required
+    #       }
+    #
+    # @!attribute [rw] subscription_name
+    #   The name of the Amazon DocumentDB event notification subscription
+    #   that you want to remove a source identifier from.
+    #   @return [String]
+    #
+    # @!attribute [rw] source_identifier
+    #   The source identifier to be removed from the subscription, such as
+    #   the instance identifier for an instance, or the name of a security
+    #   group.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveSourceIdentifierFromSubscriptionMessage AWS API Documentation
+    #
+    class RemoveSourceIdentifierFromSubscriptionMessage < Struct.new(
+      :subscription_name,
+      :source_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] event_subscription
+    #   Detailed information about an event to which you have subscribed.
+    #   @return [Types::EventSubscription]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveSourceIdentifierFromSubscriptionResult AWS API Documentation
+    #
+    class RemoveSourceIdentifierFromSubscriptionResult < Struct.new(
+      :event_subscription)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Represents the input to RemoveTagsFromResource.
     #
     # @note When making an API call, you may pass RemoveTagsFromResourceMessage
@@ -4973,6 +5437,26 @@ module Aws::DocDB
       include Aws::Structure
     end
 
+    # Amazon SNS has responded that there is a problem with the specified
+    # topic.
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SNSInvalidTopicFault AWS API Documentation
+    #
+    class SNSInvalidTopicFault < Aws::EmptyStructure; end
+
+    # You do not have permission to publish to the SNS topic Amazon Resource
+    # Name (ARN).
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SNSNoAuthorizationFault AWS API Documentation
+    #
+    class SNSNoAuthorizationFault < Aws::EmptyStructure; end
+
+    # The SNS topic Amazon Resource Name (ARN) does not exist.
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SNSTopicArnNotFoundFault AWS API Documentation
+    #
+    class SNSTopicArnNotFoundFault < Aws::EmptyStructure; end
+
     # You have exceeded the maximum number of accounts that you can share a
     # manual DB snapshot with.
     #
@@ -4986,6 +5470,12 @@ module Aws::DocDB
     #
     class SnapshotQuotaExceededFault < Aws::EmptyStructure; end
 
+    # The requested source could not be found.
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SourceNotFoundFault AWS API Documentation
+    #
+    class SourceNotFoundFault < Aws::EmptyStructure; end
+
     # @note When making an API call, you may pass StartDBClusterMessage
     #   data as a hash:
     #
@@ -5094,6 +5584,24 @@ module Aws::DocDB
     #
     class SubnetAlreadyInUse < Aws::EmptyStructure; end
 
+    # The provided subscription name already exists.
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SubscriptionAlreadyExistFault AWS API Documentation
+    #
+    class SubscriptionAlreadyExistFault < Aws::EmptyStructure; end
+
+    # The provided category does not exist.
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SubscriptionCategoryNotFoundFault AWS API Documentation
+    #
+    class SubscriptionCategoryNotFoundFault < Aws::EmptyStructure; end
+
+    # The subscription name does not exist.
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SubscriptionNotFoundFault AWS API Documentation
+    #
+    class SubscriptionNotFoundFault < Aws::EmptyStructure; end
+
     # Metadata assigned to an Amazon DocumentDB resource consisting of a
     # key-value pair.
     #