java.lang.Object
- software.amazon.awssdk.services.cloudwatchlogs.model.OpenSearchResourceConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OpenSearchResourceConfig.Builder,OpenSearchResourceConfig>
```
@Generated("software.amazon.awssdk:codegen")
public final class OpenSearchResourceConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OpenSearchResourceConfig.Builder,OpenSearchResourceConfig>
```
This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface OpenSearchResourceConfig.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`applicationArn()`	If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here.
`static OpenSearchResourceConfig.Builder`	`builder()`
`List<String>`	`dashboardViewerPrincipals()`	Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.
`String`	`dataSourceRoleArn()`	Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDashboardViewerPrincipals()`	For responses, this returns true if the service returned a value for the DashboardViewerPrincipals property.
`int`	`hashCode()`
`String`	`kmsKeyArn()`	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.
`Integer`	`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends OpenSearchResourceConfig.Builder>`	`serializableBuilderClass()`
`OpenSearchResourceConfig.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - kmsKeyArn
```
public final String kmsKeyArn()
```
    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:
    
    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.
  - dataSourceRoleArn
```
public final String 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.
    
    Returns:
    
    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.
  - hasDashboardViewerPrincipals
```
public final boolean hasDashboardViewerPrincipals()
```
    For responses, this returns true if the service returned a value for the DashboardViewerPrincipals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dashboardViewerPrincipals
```
public final List<String> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDashboardViewerPrincipals() method.
    
    Returns:
    
    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.
  - applicationArn
```
public final String 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.
    
    Returns:
    
    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.
  - retentionDays
```
public final Integer 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.
    
    Returns:
    
    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.
  - toBuilder
```
public OpenSearchResourceConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OpenSearchResourceConfig.Builder,OpenSearchResourceConfig>
  - builder
```
public static OpenSearchResourceConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends OpenSearchResourceConfig.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class OpenSearchResourceConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

kmsKeyArn

dataSourceRoleArn

hasDashboardViewerPrincipals

dashboardViewerPrincipals

applicationArn

retentionDays

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField