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

Class AssociateKmsKeyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.AssociateKmsKeyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociateKmsKeyRequest.Builder,AssociateKmsKeyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AssociateKmsKeyRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<AssociateKmsKeyRequest.Builder,AssociateKmsKeyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssociateKmsKeyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AssociateKmsKeyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId()	The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
String	logGroupName()	The name of the log group.
String	resourceIdentifier()	Specifies the target for this operation.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AssociateKmsKeyRequest.Builder>	serializableBuilderClass()
AssociateKmsKeyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

logGroupName

public final 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.

Returns:

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.

kmsKeyId

public final 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.

Returns:

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.

resourceIdentifier

public final 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.

Returns:

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.

toBuilder

public AssociateKmsKeyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociateKmsKeyRequest.Builder,AssociateKmsKeyRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static AssociateKmsKeyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AssociateKmsKeyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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