aws-sdk-cloudwatchlogs 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e517c067b342b48a2ca55e75ceb73d6c22caaaa
-  data.tar.gz: 857ff7fbea13261a6eefa81844e5e6f294dc56fd
+  metadata.gz: 830933777385cd177196133ddf6ce74d47711020
+  data.tar.gz: 563f03002863e63a5f07fc5505125890129ef055
 SHA512:
-  metadata.gz: b4ab8714b98bfd61c88694cf80aaef55a1b760ba82bd9f993046faf82c967d8b5c0a08ad531eb5ed45f3203eb5f4e5d93e5d4863c99684008d0ef05333931209
-  data.tar.gz: 4e65eca44aee95ade6dd3b6bc2d10b8fd2b0db557e31c2a9b25441e2e18dd41dd2be60d323cbce47957e4d1f8ae11e2e9ff0fd07a8349fc07d2b8177dc49fe2e
+  metadata.gz: 67fad492e7ee8db088fa5fc0edafe10b43640aa3e72d88e8c974e001457cd65742c34e3ed8e7448d1fc2d367ad67c053227968e7d1805a42c20e95ea97471fb8
+  data.tar.gz: 9706b3fc983118c5a9db1c923de014be546581b2f07201e2eb366f84a9eeb9dfc964337f895ccd92e774a968d7694d280ecdf95e57cc38952f8ff24a1fbc46b8

data/lib/aws-sdk-cloudwatchlogs.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-cloudwatchlogs/customizations'
 # @service
 module Aws::CloudWatchLogs
 
-  GEM_VERSION = '1.1.0'
+  GEM_VERSION = '1.2.0'
 
 end

data/lib/aws-sdk-cloudwatchlogs/client.rb

@@ -155,6 +155,54 @@ module Aws::CloudWatchLogs
 
     # @!group API Operations
 
+    # Associates the specified AWS Key Management Service (AWS KMS) customer
+    # master key (CMK) with the specified log group.
+    #
+    # Associating an AWS KMS CMK with a log group overrides any existing
+    # associations between the log group and a CMK. After a CMK is
+    # associated with a log group, all newly ingested data for the log group
+    # is encrypted using the CMK. This association is stored as long as the
+    # data encrypted with the CMK is still within Amazon CloudWatch Logs.
+    # This enables Amazon CloudWatch Logs to decrypt this data whenever it
+    # is requested.
+    #
+    # Note that it can take up to 5 minutes for this operation to take
+    # effect.
+    #
+    # If you attempt to associate a CMK with a log group but the CMK does
+    # not exist or the CMK is disabled, you will receive an
+    # `InvalidParameterException` error.
+    #
+    # @option params [required, String] :log_group_name
+    #   The name of the log group.
+    #
+    # @option params [required, String] :kms_key_id
+    #   The Amazon Resource Name (ARN) of the CMK to use when encrypting log
+    #   data. For more information, see [Amazon Resource Names - AWS Key
+    #   Management Service (AWS KMS)][1].
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.associate_kms_key({
+    #     log_group_name: "LogGroupName", # required
+    #     kms_key_id: "KmsKeyId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateKmsKey AWS API Documentation
+    #
+    # @overload associate_kms_key(params = {})
+    # @param [Hash] params ({})
+    def associate_kms_key(params = {}, options = {})
+      req = build_request(:associate_kms_key, params)
+      req.send_request(options)
+    end
+
     # Cancels the specified export task.
     #
     # The task must be in the `PENDING` or `RUNNING` state.
@@ -265,9 +313,28 @@ module Aws::CloudWatchLogs
     #   '\_' (underscore), '-' (hyphen), '/' (forward slash), and
     #   '.' (period).
     #
+    # If you associate a AWS Key Management Service (AWS KMS) customer
+    # master key (CMK) with the log group, ingested data is encrypted using
+    # the CMK. This association is stored as long as the data encrypted with
+    # the CMK is still within Amazon CloudWatch Logs. This enables Amazon
+    # CloudWatch Logs to decrypt this data whenever it is requested.
+    #
+    # If you attempt to associate a CMK with the log group but the CMK does
+    # not exist or the CMK is disabled, you will receive an
+    # `InvalidParameterException` error.
+    #
     # @option params [required, String] :log_group_name
     #   The name of the log group.
     #
+    # @option params [String] :kms_key_id
+    #   The Amazon Resource Name (ARN) of the CMK to use when encrypting log
+    #   data. For more information, see [Amazon Resource Names - AWS Key
+    #   Management Service (AWS KMS)][1].
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
+    #
     # @option params [Hash<String,String>] :tags
     #   The key-value pairs to use for the tags.
     #
@@ -277,6 +344,7 @@ module Aws::CloudWatchLogs
     #
     #   resp = client.create_log_group({
     #     log_group_name: "LogGroupName", # required
+    #     kms_key_id: "KmsKeyId",
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
@@ -645,6 +713,7 @@ module Aws::CloudWatchLogs
     #   resp.log_groups[0].metric_filter_count #=> Integer
     #   resp.log_groups[0].arn #=> String
     #   resp.log_groups[0].stored_bytes #=> Integer
+    #   resp.log_groups[0].kms_key_id #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogGroups AWS API Documentation
@@ -738,7 +807,7 @@ module Aws::CloudWatchLogs
     end
 
     # Lists the specified metric filters. You can list all the metric
-    # filters or filter the results by log name, prefix, metric name, and
+    # filters or filter the results by log name, prefix, metric name, or
     # metric namespace. The results are ASCII-sorted by filter name.
     #
     # @option params [String] :log_group_name
@@ -756,7 +825,9 @@ module Aws::CloudWatchLogs
     #   the default is up to 50 items.
     #
     # @option params [String] :metric_name
-    #   The name of the CloudWatch metric.
+    #   The name of the CloudWatch metric to which the monitored log
+    #   information should be published. For example, you may publish to a
+    #   metric called ErrorCount.
     #
     # @option params [String] :metric_namespace
     #   The namespace of the CloudWatch metric.
@@ -893,6 +964,38 @@ module Aws::CloudWatchLogs
       req.send_request(options)
     end
 
+    # Disassociates the associated AWS Key Management Service (AWS KMS)
+    # customer master key (CMK) from the specified log group.
+    #
+    # After the AWS KMS CMK is disassociated from the log group, AWS
+    # CloudWatch Logs stops encrypting newly ingested data for the log
+    # group. All previously ingested data remains encrypted, and AWS
+    # CloudWatch Logs requires permissions for the CMK whenever the
+    # encrypted data is requested.
+    #
+    # Note that it can take up to 5 minutes for this operation to take
+    # effect.
+    #
+    # @option params [required, String] :log_group_name
+    #   The name of the log group.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.disassociate_kms_key({
+    #     log_group_name: "LogGroupName", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateKmsKey AWS API Documentation
+    #
+    # @overload disassociate_kms_key(params = {})
+    # @param [Hash] params ({})
+    def disassociate_kms_key(params = {}, options = {})
+      req = build_request(:disassociate_kms_key, params)
+      req.send_request(options)
+    end
+
     # Lists log events from the specified log group. You can list all the
     # log events or filter the results using a filter pattern, a time range,
     # and the name of the log stream.
@@ -982,9 +1085,8 @@ module Aws::CloudWatchLogs
     # log events or filter using a time range.
     #
     # By default, this operation returns as many log events as can fit in a
-    # response size of 1 MB (up to 10,000 log events). You can get
-    # additional log events by specifying one of the tokens in a subsequent
-    # call.
+    # response size of 1MB (up to 10,000 log events). You can get additional
+    # log events by specifying one of the tokens in a subsequent call.
     #
     # @option params [required, String] :log_group_name
     #   The name of the log group.
@@ -1054,8 +1156,6 @@ module Aws::CloudWatchLogs
 
     # Lists the tags for the specified log group.
     #
-    # To add tags, use TagLogGroup. To remove tags, use UntagLogGroup.
-    #
     # @option params [required, String] :log_group_name
     #   The name of the log group.
     #
@@ -1438,10 +1538,10 @@ module Aws::CloudWatchLogs
     #   cross-account delivery.
     #
     # @option params [String] :distribution
-    #   The method used to distribute log data to the destination, when the
-    #   destination is an Amazon Kinesis stream. By default, log data is
-    #   grouped by log stream. For a more even distribution, you can group log
-    #   data randomly.
+    #   The method used to distribute log data to the destination. By default
+    #   log data is grouped by log stream, but the grouping can be set to
+    #   random for a more even distribution. This property is only applicable
+    #   when the destination is an Amazon Kinesis stream.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -1586,7 +1686,7 @@ module Aws::CloudWatchLogs
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatchlogs'
-      context[:gem_version] = '1.1.0'
+      context[:gem_version] = '1.2.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cloudwatchlogs/client_api.rb

@@ -13,6 +13,7 @@ module Aws::CloudWatchLogs
 
     AccessPolicy = Shapes::StringShape.new(name: 'AccessPolicy')
     Arn = Shapes::StringShape.new(name: 'Arn')
+    AssociateKmsKeyRequest = Shapes::StructureShape.new(name: 'AssociateKmsKeyRequest')
     CancelExportTaskRequest = Shapes::StructureShape.new(name: 'CancelExportTaskRequest')
     CreateExportTaskRequest = Shapes::StructureShape.new(name: 'CreateExportTaskRequest')
     CreateExportTaskResponse = Shapes::StructureShape.new(name: 'CreateExportTaskResponse')
@@ -48,6 +49,7 @@ module Aws::CloudWatchLogs
     DestinationArn = Shapes::StringShape.new(name: 'DestinationArn')
     DestinationName = Shapes::StringShape.new(name: 'DestinationName')
     Destinations = Shapes::ListShape.new(name: 'Destinations')
+    DisassociateKmsKeyRequest = Shapes::StructureShape.new(name: 'DisassociateKmsKeyRequest')
     Distribution = Shapes::StringShape.new(name: 'Distribution')
     EventId = Shapes::StringShape.new(name: 'EventId')
     EventMessage = Shapes::StringShape.new(name: 'EventMessage')
@@ -80,6 +82,7 @@ module Aws::CloudWatchLogs
     InvalidOperationException = Shapes::StructureShape.new(name: 'InvalidOperationException')
     InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
     InvalidSequenceTokenException = Shapes::StructureShape.new(name: 'InvalidSequenceTokenException')
+    KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
     LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
     ListTagsLogGroupRequest = Shapes::StructureShape.new(name: 'ListTagsLogGroupRequest')
     ListTagsLogGroupResponse = Shapes::StructureShape.new(name: 'ListTagsLogGroupResponse')
@@ -145,6 +148,10 @@ module Aws::CloudWatchLogs
     UntagLogGroupRequest = Shapes::StructureShape.new(name: 'UntagLogGroupRequest')
     Value = Shapes::StringShape.new(name: 'Value')
 
+    AssociateKmsKeyRequest.add_member(:log_group_name, Shapes::ShapeRef.new(shape: LogGroupName, required: true, location_name: "logGroupName"))
+    AssociateKmsKeyRequest.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, required: true, location_name: "kmsKeyId"))
+    AssociateKmsKeyRequest.struct_class = Types::AssociateKmsKeyRequest
+
     CancelExportTaskRequest.add_member(:task_id, Shapes::ShapeRef.new(shape: ExportTaskId, required: true, location_name: "taskId"))
     CancelExportTaskRequest.struct_class = Types::CancelExportTaskRequest
 
@@ -161,6 +168,7 @@ module Aws::CloudWatchLogs
     CreateExportTaskResponse.struct_class = Types::CreateExportTaskResponse
 
     CreateLogGroupRequest.add_member(:log_group_name, Shapes::ShapeRef.new(shape: LogGroupName, required: true, location_name: "logGroupName"))
+    CreateLogGroupRequest.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "kmsKeyId"))
     CreateLogGroupRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
     CreateLogGroupRequest.struct_class = Types::CreateLogGroupRequest
 
@@ -272,6 +280,9 @@ module Aws::CloudWatchLogs
 
     Destinations.member = Shapes::ShapeRef.new(shape: Destination)
 
+    DisassociateKmsKeyRequest.add_member(:log_group_name, Shapes::ShapeRef.new(shape: LogGroupName, required: true, location_name: "logGroupName"))
+    DisassociateKmsKeyRequest.struct_class = Types::DisassociateKmsKeyRequest
+
     ExportTask.add_member(:task_id, Shapes::ShapeRef.new(shape: ExportTaskId, location_name: "taskId"))
     ExportTask.add_member(:task_name, Shapes::ShapeRef.new(shape: ExportTaskName, location_name: "taskName"))
     ExportTask.add_member(:log_group_name, Shapes::ShapeRef.new(shape: LogGroupName, location_name: "logGroupName"))
@@ -354,6 +365,7 @@ module Aws::CloudWatchLogs
     LogGroup.add_member(:metric_filter_count, Shapes::ShapeRef.new(shape: FilterCount, location_name: "metricFilterCount"))
     LogGroup.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "arn"))
     LogGroup.add_member(:stored_bytes, Shapes::ShapeRef.new(shape: StoredBytes, location_name: "storedBytes"))
+    LogGroup.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "kmsKeyId"))
     LogGroup.struct_class = Types::LogGroup
 
     LogGroups.member = Shapes::ShapeRef.new(shape: LogGroup)
@@ -514,6 +526,18 @@ module Aws::CloudWatchLogs
         "targetPrefix" => "Logs_20140328",
       }
 
+      api.add_operation(:associate_kms_key, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "AssociateKmsKey"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: AssociateKmsKeyRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: OperationAbortedException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+      end)
+
       api.add_operation(:cancel_export_task, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CancelExportTask"
         o.http_method = "POST"
@@ -751,6 +775,18 @@ module Aws::CloudWatchLogs
         )
       end)
 
+      api.add_operation(:disassociate_kms_key, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DisassociateKmsKey"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DisassociateKmsKeyRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: OperationAbortedException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+      end)
+
       api.add_operation(:filter_log_events, Seahorse::Model::Operation.new.tap do |o|
         o.name = "FilterLogEvents"
         o.http_method = "POST"

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

@@ -8,6 +8,36 @@
 module Aws::CloudWatchLogs
   module Types
 
+    # @note When making an API call, you may pass AssociateKmsKeyRequest
+    #   data as a hash:
+    #
+    #       {
+    #         log_group_name: "LogGroupName", # required
+    #         kms_key_id: "KmsKeyId", # required
+    #       }
+    #
+    # @!attribute [rw] log_group_name
+    #   The name of the log group.
+    #   @return [String]
+    #
+    # @!attribute [rw] kms_key_id
+    #   The Amazon Resource Name (ARN) of the CMK to use when encrypting log
+    #   data. For more information, see [Amazon Resource Names - AWS Key
+    #   Management Service (AWS KMS)][1].
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateKmsKeyRequest AWS API Documentation
+    #
+    class AssociateKmsKeyRequest < Struct.new(
+      :log_group_name,
+      :kms_key_id)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CancelExportTaskRequest
     #   data as a hash:
     #
@@ -103,6 +133,7 @@ module Aws::CloudWatchLogs
     #
     #       {
     #         log_group_name: "LogGroupName", # required
+    #         kms_key_id: "KmsKeyId",
     #         tags: {
     #           "TagKey" => "TagValue",
     #         },
@@ -112,6 +143,16 @@ module Aws::CloudWatchLogs
     #   The name of the log group.
     #   @return [String]
     #
+    # @!attribute [rw] kms_key_id
+    #   The Amazon Resource Name (ARN) of the CMK to use when encrypting log
+    #   data. For more information, see [Amazon Resource Names - AWS Key
+    #   Management Service (AWS KMS)][1].
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
+    #   @return [String]
+    #
     # @!attribute [rw] tags
     #   The key-value pairs to use for the tags.
     #   @return [Hash<String,String>]
@@ -120,6 +161,7 @@ module Aws::CloudWatchLogs
     #
     class CreateLogGroupRequest < Struct.new(
       :log_group_name,
+      :kms_key_id,
       :tags)
       include Aws::Structure
     end
@@ -562,7 +604,9 @@ module Aws::CloudWatchLogs
     #   @return [Integer]
     #
     # @!attribute [rw] metric_name
-    #   The name of the CloudWatch metric.
+    #   The name of the CloudWatch metric to which the monitored log
+    #   information should be published. For example, you may publish to a
+    #   metric called ErrorCount.
     #   @return [String]
     #
     # @!attribute [rw] metric_namespace
@@ -740,6 +784,24 @@ module Aws::CloudWatchLogs
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DisassociateKmsKeyRequest
+    #   data as a hash:
+    #
+    #       {
+    #         log_group_name: "LogGroupName", # required
+    #       }
+    #
+    # @!attribute [rw] log_group_name
+    #   The name of the log group.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateKmsKeyRequest AWS API Documentation
+    #
+    class DisassociateKmsKeyRequest < Struct.new(
+      :log_group_name)
+      include Aws::Structure
+    end
+
     # Represents an export task.
     #
     # @!attribute [rw] task_id
@@ -1099,7 +1161,7 @@ module Aws::CloudWatchLogs
     end
 
     # @!attribute [rw] tags
-    #   The tags.
+    #   The tags for the log group.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsLogGroupResponse AWS API Documentation
@@ -1138,6 +1200,11 @@ module Aws::CloudWatchLogs
     #   The number of bytes stored.
     #   @return [Integer]
     #
+    # @!attribute [rw] kms_key_id
+    #   The Amazon Resource Name (ARN) of the CMK to use when encrypting log
+    #   data.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LogGroup AWS API Documentation
     #
     class LogGroup < Struct.new(
@@ -1146,7 +1213,8 @@ module Aws::CloudWatchLogs
       :retention_in_days,
       :metric_filter_count,
       :arn,
-      :stored_bytes)
+      :stored_bytes,
+      :kms_key_id)
       include Aws::Structure
     end
 
@@ -1637,10 +1705,10 @@ module Aws::CloudWatchLogs
     #   @return [String]
     #
     # @!attribute [rw] distribution
-    #   The method used to distribute log data to the destination, when the
-    #   destination is an Amazon Kinesis stream. By default, log data is
-    #   grouped by log stream. For a more even distribution, you can group
-    #   log data randomly.
+    #   The method used to distribute log data to the destination. By
+    #   default log data is grouped by log stream, but the grouping can be
+    #   set to random for a more even distribution. This property is only
+    #   applicable when the destination is an Amazon Kinesis stream.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutSubscriptionFilterRequest AWS API Documentation
@@ -1746,8 +1814,8 @@ module Aws::CloudWatchLogs
     #   @return [String]
     #
     # @!attribute [rw] distribution
-    #   The method used to distribute log data to the destination, when the
-    #   destination is an Amazon Kinesis stream.
+    #   The method used to distribute log data to the destination, which can
+    #   be either random or grouped by log stream.
     #   @return [String]
     #
     # @!attribute [rw] creation_time

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatchlogs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core