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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GetKeyPolicyRequest.BuilderkeyId(String keyId)Gets the key policy for the specified KMS key.GetKeyPolicyRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)GetKeyPolicyRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)GetKeyPolicyRequest.BuilderpolicyName(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 Detail
-
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 isdefault. 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)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
GetKeyPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-