Class: AWSCDK::OpenSearchService::CfnDomain::LogPublishingOptionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::OpenSearchService::CfnDomain::LogPublishingOptionProperty

Defined in:

open_search_service/cfn_domain.rb

Overview

Specifies whether the OpenSearch Service domain publishes application, search slow logs, or index slow logs to Amazon CloudWatch.

Each option must be an object of name SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , or AUDIT_LOGS depending on the type of logs you want to publish. For the full syntax, see the examples .

Before you enable log publishing, you need to create a CloudWatch log group and provide OpenSearch Service the correct permissions to write to it. To learn more, see Enabling log publishing ( AWS CloudFormation) .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html

Instance Attribute Summary

• #cloud_watch_logs_log_group_arn ⇒ String^? readonly

  Specifies the CloudWatch log group to publish to.

• #enabled ⇒ Boolean, ... readonly

  If true , enables the publishing of logs to CloudWatch.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(cloud_watch_logs_log_group_arn: nil, enabled: nil) ⇒ LogPublishingOptionProperty constructor

  A new instance of LogPublishingOptionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(cloud_watch_logs_log_group_arn: nil, enabled: nil) ⇒ LogPublishingOptionProperty

Returns a new instance of LogPublishingOptionProperty.

Parameters:

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

  Specifies the CloudWatch log group to publish to.

• enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  If true , enables the publishing of logs to CloudWatch.

# File 'open_search_service/cfn_domain.rb', line 1908

def initialize(cloud_watch_logs_log_group_arn: nil, enabled: nil)
  @cloud_watch_logs_log_group_arn = cloud_watch_logs_log_group_arn
  Jsii::Type.check_type(@cloud_watch_logs_log_group_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cloudWatchLogsLogGroupArn") unless @cloud_watch_logs_log_group_arn.nil?
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless @enabled.nil?
end

Instance Attribute Details

#cloud_watch_logs_log_group_arn ⇒ String^? (readonly)

Specifies the CloudWatch log group to publish to.

Required if you enable log publishing.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html#cfn-opensearchservice-domain-logpublishingoption-cloudwatchlogsloggrouparn

# File 'open_search_service/cfn_domain.rb', line 1921

def cloud_watch_logs_log_group_arn
  @cloud_watch_logs_log_group_arn
end

#enabled ⇒ Boolean, ... (readonly)

If true , enables the publishing of logs to CloudWatch.

Default: false .

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html#cfn-opensearchservice-domain-logpublishingoption-enabled

# File 'open_search_service/cfn_domain.rb', line 1928

def enabled
  @enabled
end

Class Method Details

.jsii_properties ⇒ Object

# File 'open_search_service/cfn_domain.rb', line 1930

def self.jsii_properties
  {
    :cloud_watch_logs_log_group_arn => "cloudWatchLogsLogGroupArn",
    :enabled => "enabled",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'open_search_service/cfn_domain.rb', line 1937

def to_jsii
  result = {}
  result.merge!({
    "cloudWatchLogsLogGroupArn" => @cloud_watch_logs_log_group_arn,
    "enabled" => @enabled,
  })
  result.compact
end