Class: Aws::CloudWatchLogs::Types::OpenSearchResourceConfig

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

Overview

This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_arn ⇒ String

If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created.

Returns:

  • (String) 


4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 4985

class OpenSearchResourceConfig < Struct.new(
  :kms_key_arn,
  :data_source_role_arn,
  :dashboard_viewer_principals,
  :application_arn,
  :retention_days)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_viewer_principals ⇒ Array<String>

Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.

In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardsAccess IAM policy. For more information, see

Returns:

  • (Array<String>) 


4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 4985

class OpenSearchResourceConfig < Struct.new(
  :kms_key_arn,
  :data_source_role_arn,
  :dashboard_viewer_principals,
  :application_arn,
  :retention_days)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_role_arn ⇒ String

Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see Create an IAM role to access the OpenSearch Service collection in the CloudWatch Logs User Guide.

Returns:

  • (String) 


4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 4985

class OpenSearchResourceConfig < Struct.new(
  :kms_key_arn,
  :data_source_role_arn,
  :dashboard_viewer_principals,
  :application_arn,
  :retention_days)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

To have the vended dashboard data encrypted with KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the KMS key that you want to use.

Returns:

  • (String) 


4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 4985

class OpenSearchResourceConfig < Struct.new(
  :kms_key_arn,
  :data_source_role_arn,
  :dashboard_viewer_principals,
  :application_arn,
  :retention_days)
  SENSITIVE = []
  include Aws::Structure
end

#retention_days ⇒ Integer

Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs.

Returns:

  • (Integer) 


4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 4985

class OpenSearchResourceConfig < Struct.new(
  :kms_key_arn,
  :data_source_role_arn,
  :dashboard_viewer_principals,
  :application_arn,
  :retention_days)
  SENSITIVE = []
  include Aws::Structure
end