AWS::Logs::Integration OpenSearchResourceConfig - AWS CloudFormation
SyntaxProperties

AWS::Logs::Integration OpenSearchResourceConfig

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ApplicationARN" : String,
  "DashboardViewerPrincipals" : [ String, ... ],
  "DataSourceRoleArn" : String,
  "KmsKeyArn" : String,
  "RetentionDays" : Integer
}

YAML

  ApplicationARN: String
  DashboardViewerPrincipals: 
    - String
  DataSourceRoleArn: String
  KmsKeyArn: String
  RetentionDays: Integer

Properties

ApplicationARN

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.

Required: No

Type: String

Pattern: [\w#+=/:,.@-]*\*?

Minimum: 20

Maximum: 2048

Update requires: Replacement

DashboardViewerPrincipals

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

Important

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

Required: Yes

Type: Array of String

Update requires: Replacement

DataSourceRoleArn

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 Permissions that the integration needs in the CloudWatch Logs User Guide.

Required: Yes

Type: String

Pattern: [\w#+=/:,.@-]*\*?

Minimum: 20

Maximum: 2048

Update requires: Replacement

KmsKeyArn

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

Required: No

Type: String

Pattern: [\w#+=/:,.@-]*\*?

Minimum: 20

Maximum: 2048

Update requires: Replacement

RetentionDays

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.

Required: No

Type: Integer

Minimum: 1

Maximum: 3650

Update requires: Replacement