PutEncryptionConfigRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.xray.model

Class PutEncryptionConfigRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.xray.model.PutEncryptionConfigRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutEncryptionConfigRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

PutEncryptionConfigRequest ()

Constructors
Constructor and Description
`PutEncryptionConfigRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`PutEncryptionConfigRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getKeyId ()` An Amazon Web Services KMS key in one of the following formats:
`String`	`getType ()` The type of encryption.
`int`	`hashCode ()`
`void`	`setKeyId (String keyId)` An Amazon Web Services KMS key in one of the following formats:
`void`	`setType (String type)` The type of encryption.
`String`	`toString ()` Returns a string representation of this object.
`PutEncryptionConfigRequest`	`withKeyId (String keyId)` An Amazon Web Services KMS key in one of the following formats:
`PutEncryptionConfigRequest`	`withType (EncryptionType type)` The type of encryption.
`PutEncryptionConfigRequest`	`withType (String type)` The type of encryption.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutEncryptionConfigRequest
```
public PutEncryptionConfigRequest()
```
- Method Detail
  - setKeyId
```
public void setKeyId(String keyId)
```
    An Amazon Web Services KMS key in one of the following formats:
    - Alias - The name of the key. For example, alias/MyKey.
    - Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
    - ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
    Omit this key if you set Type to NONE.
    Parameters:
    keyId - An Amazon Web Services KMS key in one of the following formats:
    
    Alias - The name of the key. For example, alias/MyKey.
    
    Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456 . Amazon Web Services X-Ray does not support asymmetric KMS keys.
    
    ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
    
    Omit this key if you set Type to NONE.
  - getKeyId
```
public String getKeyId()
```
    An Amazon Web Services KMS key in one of the following formats:
    - Alias - The name of the key. For example, alias/MyKey.
    - Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
    - ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
    Omit this key if you set Type to NONE.
    Returns:
    An Amazon Web Services KMS key in one of the following formats:
    
    Alias - The name of the key. For example, alias/MyKey.
    
    Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
    
    ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
    
    Omit this key if you set Type to NONE.
  - withKeyId
```
public PutEncryptionConfigRequest withKeyId(String keyId)
```
    An Amazon Web Services KMS key in one of the following formats:
    - Alias - The name of the key. For example, alias/MyKey.
    - Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
    - ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
    Omit this key if you set Type to NONE.
    Parameters:
    keyId - An Amazon Web Services KMS key in one of the following formats:
    
    Alias - The name of the key. For example, alias/MyKey.
    
    Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456 . Amazon Web Services X-Ray does not support asymmetric KMS keys.
    
    ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
    
    Omit this key if you set Type to NONE.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
    
    Parameters:
    
    type - The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
    
    See Also:
    
    EncryptionType
  - getType
```
public String getType()
```
    The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
    
    Returns:
    
    The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
    
    See Also:
    
    EncryptionType
  - withType
```
public PutEncryptionConfigRequest withType(String type)
```
    The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
    
    Parameters:
    
    type - The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionType
  - withType
```
public PutEncryptionConfigRequest withType(EncryptionType type)
```
    The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
    
    Parameters:
    
    type - The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionType
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutEncryptionConfigRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class PutEncryptionConfigRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutEncryptionConfigRequest

Method Detail

setKeyId

getKeyId

withKeyId

setType

getType

withType

withType

toString

equals

hashCode

clone