Package software.amazon.awscdk.cfnpropertymixins.services.logs

Class CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.logs.CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty>

Enclosing interface:

CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty

@Stability(Stable)
public static final class CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty>

A builder for CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder	applicationArn(String applicationArn)	Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getApplicationArn()
CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty	build()	Builds the configured instance.
CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder	dashboardViewerPrincipals(List<String> dashboardViewerPrincipals)	Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getDashboardViewerPrincipals()
CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder	dataSourceRoleArn(String dataSourceRoleArn)	Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getDataSourceRoleArn()
CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder	kmsKeyArn(String kmsKeyArn)	Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getKmsKeyArn()
CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder	retentionDays(Number retentionDays)	Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getRetentionDays()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

applicationArn

@Stability(Stable)
public CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder applicationArn(String applicationArn)

Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getApplicationArn()

Parameters:

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:

this

dashboardViewerPrincipals

@Stability(Stable)
public CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder dashboardViewerPrincipals(List<String> dashboardViewerPrincipals)

Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getDashboardViewerPrincipals()

Parameters:

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 .

Returns:

this

dataSourceRoleArn

@Stability(Stable)
public CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder dataSourceRoleArn(String dataSourceRoleArn)

Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getDataSourceRoleArn()

Parameters:

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:

this

kmsKeyArn

@Stability(Stable)
public CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder kmsKeyArn(String kmsKeyArn)

Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getKmsKeyArn()

Parameters:

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

Returns:

this

retentionDays

@Stability(Stable)
public CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.Builder retentionDays(Number retentionDays)

Sets the value of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty.getRetentionDays()

Parameters:

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:

this

build

@Stability(Stable)
public CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty>

Returns:

a new instance of CfnIntegrationPropsMixin.OpenSearchResourceConfigProperty

Throws:

NullPointerException - if any required attribute was not provided