Interface OpenSearchResourceConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OpenSearchResourceConfig.Builder,OpenSearchResourceConfig>, SdkBuilder<OpenSearchResourceConfig.Builder,OpenSearchResourceConfig>, SdkPojo
Enclosing class:
OpenSearchResourceConfig
@Mutable @NotThreadSafe public static interface OpenSearchResourceConfig.Builder extends SdkPojo, CopyableBuilder<OpenSearchResourceConfig.Builder,OpenSearchResourceConfig>

  • Method Details

    • kmsKeyArn

      OpenSearchResourceConfig.Builder kmsKeyArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceRoleArn

      OpenSearchResourceConfig.Builder dataSourceRoleArn(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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • dashboardViewerPrincipals

      OpenSearchResourceConfig.Builder dashboardViewerPrincipals(Collection<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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • dashboardViewerPrincipals

      OpenSearchResourceConfig.Builder dashboardViewerPrincipals(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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • applicationArn

      OpenSearchResourceConfig.Builder applicationArn(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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • retentionDays

      OpenSearchResourceConfig.Builder retentionDays(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.

      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:
      Returns a reference to this object so that method calls can be chained together.