Package software.amazon.awssdk.services.cloudwatchlogs.model

Interface AssociateKmsKeyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudWatchLogsRequest.Builder, CopyableBuilder<AssociateKmsKeyRequest.Builder,AssociateKmsKeyRequest>, SdkBuilder<AssociateKmsKeyRequest.Builder,AssociateKmsKeyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

AssociateKmsKeyRequest

public static interface AssociateKmsKeyRequest.Builder
extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder<AssociateKmsKeyRequest.Builder,AssociateKmsKeyRequest>

Method Summary

Modifier and Type	Method	Description
AssociateKmsKeyRequest.Builder	kmsKeyId(String kmsKeyId)	The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
AssociateKmsKeyRequest.Builder	logGroupName(String logGroupName)	The name of the log group.
AssociateKmsKeyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AssociateKmsKeyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AssociateKmsKeyRequest.Builder	resourceIdentifier(String resourceIdentifier)	Specifies the target for this operation.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

logGroupName

AssociateKmsKeyRequest.Builder logGroupName(String logGroupName)

The name of the log group.

In your AssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can't specify both.

Parameters:

logGroupName - The name of the log group.

In your AssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can't specify both.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

AssociateKmsKeyRequest.Builder kmsKeyId(String kmsKeyId)

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceIdentifier

AssociateKmsKeyRequest.Builder resourceIdentifier(String resourceIdentifier)

Specifies the target for this operation. You must specify one of the following:

• Specify the following ARN to have future GetQueryResults operations in this account encrypt the results with the specified KMS key. Replace REGION and ACCOUNT_ID with your Region and account ID.

  arn:aws:logs:REGION:ACCOUNT_ID:query-result:*

• Specify the ARN of a log group to have CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. The log group ARN must be in the following format. Replace REGION and ACCOUNT_ID with your Region and account ID.

  arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME

In your AssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can't specify both.

Parameters:

resourceIdentifier - Specifies the target for this operation. You must specify one of the following:

• Specify the following ARN to have future GetQueryResults operations in this account encrypt the results with the specified KMS key. Replace REGION and ACCOUNT_ID with your Region and account ID.

  arn:aws:logs:REGION:ACCOUNT_ID:query-result:*

• Specify the ARN of a log group to have CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. The log group ARN must be in the following format. Replace REGION and ACCOUNT_ID with your Region and account ID.

  arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME

In your AssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can't specify both.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

AssociateKmsKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

AssociateKmsKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder