Struct OpenSearchResourceConfig 

#[non_exhaustive]
pub struct OpenSearchResourceConfig {
    pub kms_key_arn: Option<String>,
    pub data_source_role_arn: String,
    pub dashboard_viewer_principals: Vec<String>,
    pub application_arn: Option<String>,
    pub retention_days: i32,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kms_key_arn: Option<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.

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

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

application_arn: Option<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.

retention_days: i32

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.

Implementations

impl OpenSearchResourceConfig

pub fn kms_key_arn(&self) -> Option<&str>

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.

pub fn data_source_role_arn(&self) -> &str

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.

pub fn dashboard_viewer_principals(&self) -> &[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 CloudWatchOpenSearchDashboardAccess IAM policy. For more information, see IAM policies for users.

pub fn application_arn(&self) -> Option<&str>

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.

pub fn retention_days(&self) -> i32

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.

impl OpenSearchResourceConfig

pub fn builder() -> OpenSearchResourceConfigBuilder

Creates a new builder-style object to manufacture OpenSearchResourceConfig.

Trait Implementations

impl Clone for OpenSearchResourceConfig

fn clone(&self) -> OpenSearchResourceConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenSearchResourceConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OpenSearchResourceConfig

fn eq(&self, other: &OpenSearchResourceConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OpenSearchResourceConfig