Class: AWSCDK::SSM::CfnMaintenanceWindowTask::LoggingInfoProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ssm/cfn_maintenance_window_task.rb

Overview

LoggingInfo has been deprecated.

To specify an Amazon 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 AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters .

The LoggingInfo property type specifies information about the Amazon S3 bucket to write instance-level logs to.

LoggingInfo is a property of the AWS::SSM::MaintenanceWindowTask resource.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(region:, s3_bucket:, s3_prefix: nil) ⇒ LoggingInfoProperty

Returns a new instance of LoggingInfoProperty.

Parameters:

  • region (String) —

    The AWS Region where the S3 bucket is located.

  • s3_bucket (String) —

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

  • s3_prefix (String, nil) (defaults to: nil) —

    The Amazon S3 bucket subfolder.



735
736
737
738
739
740
741
742
 
# File 'ssm/cfn_maintenance_window_task.rb', line 735

def initialize(region:, s3_bucket:, s3_prefix: nil)
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region")
  @s3_bucket = s3_bucket
  Jsii::Type.check_type(@s3_bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Bucket")
  @s3_prefix = s3_prefix
  Jsii::Type.check_type(@s3_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Prefix") unless @s3_prefix.nil?
end

Instance Attribute Details

#region ⇒ String (readonly)

The AWS Region where the S3 bucket is located.

Returns:

  • (String)

See Also:



748
749
750
 
# File 'ssm/cfn_maintenance_window_task.rb', line 748

def region
  @region
end

#s3_bucket ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



753
754
755
 
# File 'ssm/cfn_maintenance_window_task.rb', line 753

def s3_bucket
  @s3_bucket
end

#s3_prefix ⇒ String? (readonly)

The Amazon S3 bucket subfolder.

Returns:

  • (String, nil)

See Also:



758
759
760
 
# File 'ssm/cfn_maintenance_window_task.rb', line 758

def s3_prefix
  @s3_prefix
end

Class Method Details

.jsii_properties ⇒ Object 



760
761
762
763
764
765
766
 
# File 'ssm/cfn_maintenance_window_task.rb', line 760

def self.jsii_properties
  {
    :region => "region",
    :s3_bucket => "s3Bucket",
    :s3_prefix => "s3Prefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



768
769
770
771
772
773
774
775
776
 
# File 'ssm/cfn_maintenance_window_task.rb', line 768

def to_jsii
  result = {}
  result.merge!({
    "region" => @region,
    "s3Bucket" => @s3_bucket,
    "s3Prefix" => @s3_prefix,
  })
  result.compact
end