class
Amazonite::CloudWatchLogs::OpenSearchResourceConfig
- Amazonite::CloudWatchLogs::OpenSearchResourceConfig
- Reference
- Object
Overview
This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
Included Modules
- JSON::Serializable
Defined in:
cloudwatch_logs/open_search_resource_config.crConstructors
- .new(data_source_role_arn : String, dashboard_viewer_principals : Array(String), retention_days : Int32, kms_key_arn : String | Nil = nil, application_arn : String | Nil = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#application_arn : String | Nil
If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here.
-
#application_arn=(application_arn : String | Nil)
If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here.
-
#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.
-
#dashboard_viewer_principals=(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.
-
#data_source_role_arn : String
Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration.
-
#data_source_role_arn=(data_source_role_arn : String)
Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration.
-
#hash(hasher)
See
Object#hash(hasher) -
#kms_key_arn : String | Nil
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.
-
#kms_key_arn=(kms_key_arn : String | Nil)
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 : Int32
Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to.
-
#retention_days=(retention_days : Int32)
Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.