You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::LoggingInfo

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass LoggingInfo data as a hash:

{
  s3_bucket_name: "S3BucketName", # required
  s3_key_prefix: "S3KeyPrefix",
  s3_region: "S3Region", # required
}

Information about an Amazon S3 bucket to write instance-level logs to.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported Maintenance Window task types, see MaintenanceWindowTaskInvocationParameters.

Instance Attribute Summary collapse

Instance Attribute Details

#s3_bucket_nameString

The name of an Amazon S3 bucket where execution logs are stored .

Returns:

  • (String)


7921
7922
7923
7924
7925
7926
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7921

class LoggingInfo < Struct.new(
  :s3_bucket_name,
  :s3_key_prefix,
  :s3_region)
  include Aws::Structure
end

#s3_key_prefixString

(Optional) The Amazon S3 bucket subfolder.

Returns:

  • (String)


7921
7922
7923
7924
7925
7926
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7921

class LoggingInfo < Struct.new(
  :s3_bucket_name,
  :s3_key_prefix,
  :s3_region)
  include Aws::Structure
end

#s3_regionString

The region where the Amazon S3 bucket is located.

Returns:

  • (String)


7921
7922
7923
7924
7925
7926
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7921

class LoggingInfo < Struct.new(
  :s3_bucket_name,
  :s3_key_prefix,
  :s3_region)
  include Aws::Structure
end