Package software.amazon.awssdk.services.kms.model

Interface GetKeyPolicyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetKeyPolicyRequest.Builder,GetKeyPolicyRequest>, KmsRequest.Builder, SdkBuilder<GetKeyPolicyRequest.Builder,GetKeyPolicyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetKeyPolicyRequest

public static interface GetKeyPolicyRequest.Builder
extends KmsRequest.Builder, SdkPojo, CopyableBuilder<GetKeyPolicyRequest.Builder,GetKeyPolicyRequest>

Method Summary

Modifier and Type	Method	Description
GetKeyPolicyRequest.Builder	keyId(String keyId)	Gets the key policy for the specified KMS key.
GetKeyPolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetKeyPolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
GetKeyPolicyRequest.Builder	policyName(String policyName)	Specifies the name of the key policy.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

keyId

GetKeyPolicyRequest.Builder keyId(String keyId)

Gets the key policy for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Parameters:

keyId - Gets the key policy for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Returns:

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

policyName

GetKeyPolicyRequest.Builder policyName(String policyName)

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Parameters:

policyName - Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Returns:

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

overrideConfiguration

GetKeyPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.