Skip to content

OpenSearchResourceConfig

Source code in docs_src/capo_cloudwatch_logs/types/open_search_resource_config.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class OpenSearchResourceConfig(TypedDict, closed=True):
    kms_key_arn: NotRequired["capo_cloudwatch_logs.types.arn.Arn"]
    """<p>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.</p>"""
    data_source_role_arn: "capo_cloudwatch_logs.types.arn.Arn"
    """<p>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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-CreateRole.html">Permissions that the integration needs</a> in the CloudWatch Logs User Guide.</p>"""
    dashboard_viewer_principals: "capo_cloudwatch_logs.types.dashboard_viewer_principals.DashboardViewerPrincipals"
    """<p>Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.</p> <important> <p>In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardAccess</b> IAM policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-UserRoles.html">IAM policies for users</a>.</p> </important>"""
    application_arn: NotRequired["capo_cloudwatch_logs.types.arn.Arn"]
    """<p>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.</p>"""
    retention_days: (
        "capo_cloudwatch_logs.types.collection_retention_days.CollectionRetentionDays"
    )
    """<p>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. </p>"""

application_arn instance-attribute 

application_arn: NotRequired[Arn]

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.

dashboard_viewer_principals instance-attribute 

dashboard_viewer_principals: DashboardViewerPrincipals

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 CloudWatchOpenSearchDashboardAccess IAM policy. For more information, see IAM policies for users.

data_source_role_arn instance-attribute 

data_source_role_arn: Arn

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.

kms_key_arn instance-attribute 

kms_key_arn: NotRequired[Arn]

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.

retention_days instance-attribute 

retention_days: CollectionRetentionDays

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.