Class: AWSCDK::InternetMonitor::CfnMonitor::S3ConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
internet_monitor/cfn_monitor.rb

Overview

The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.

The configuration includes the bucket name and (optionally) bucket prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED if you choose to deliver internet measurements to S3 logs, and DISABLED otherwise.

The measurements are also published to Amazon CloudWatch Logs.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name: nil, bucket_prefix: nil, log_delivery_status: nil) ⇒ S3ConfigProperty

Returns a new instance of S3ConfigProperty.

Parameters:

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

    The Amazon S3 bucket name for internet measurements publishing.

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

    An optional Amazon S3 bucket prefix for internet measurements publishing.

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

    The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.



901
902
903
904
905
906
907
908
 
# File 'internet_monitor/cfn_monitor.rb', line 901

def initialize(bucket_name: nil, bucket_prefix: nil, log_delivery_status: nil)
  @bucket_name = bucket_name
  Jsii::Type.check_type(@bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketName") unless @bucket_name.nil?
  @bucket_prefix = bucket_prefix
  Jsii::Type.check_type(@bucket_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketPrefix") unless @bucket_prefix.nil?
  @log_delivery_status = log_delivery_status
  Jsii::Type.check_type(@log_delivery_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logDeliveryStatus") unless @log_delivery_status.nil?
end

Instance Attribute Details

#bucket_name ⇒ String? (readonly)

The Amazon S3 bucket name for internet measurements publishing.

Returns:

  • (String, nil)

See Also:



914
915
916
 
# File 'internet_monitor/cfn_monitor.rb', line 914

def bucket_name
  @bucket_name
end

#bucket_prefix ⇒ String? (readonly)

An optional Amazon S3 bucket prefix for internet measurements publishing.

Returns:

  • (String, nil)

See Also:



919
920
921
 
# File 'internet_monitor/cfn_monitor.rb', line 919

def bucket_prefix
  @bucket_prefix
end

#log_delivery_status ⇒ String? (readonly)

The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.

The delivery status is ENABLED if you choose to deliver internet measurements to an S3 bucket, and DISABLED otherwise.

Returns:

  • (String, nil)

See Also:



926
927
928
 
# File 'internet_monitor/cfn_monitor.rb', line 926

def log_delivery_status
  @log_delivery_status
end

Class Method Details

.jsii_properties ⇒ Object 



928
929
930
931
932
933
934
 
# File 'internet_monitor/cfn_monitor.rb', line 928

def self.jsii_properties
  {
    :bucket_name => "bucketName",
    :bucket_prefix => "bucketPrefix",
    :log_delivery_status => "logDeliveryStatus",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



936
937
938
939
940
941
942
943
944
 
# File 'internet_monitor/cfn_monitor.rb', line 936

def to_jsii
  result = {}
  result.merge!({
    "bucketName" => @bucket_name,
    "bucketPrefix" => @bucket_prefix,
    "logDeliveryStatus" => @log_delivery_status,
  })
  result.compact
end