com.oracle.bmc.keymanagement.model

Class CreateKeyDetails.Builder

java.lang.Object

com.oracle.bmc.keymanagement.model.CreateKeyDetails.Builder

Enclosing class:

CreateKeyDetails

public static class CreateKeyDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CreateKeyDetails.Builder	autoKeyRotationDetails(AutoKeyRotationDetails autoKeyRotationDetails)
CreateKeyDetails	build()
CreateKeyDetails.Builder	compartmentId(String compartmentId) The OCID of the compartment where you want to create the master encryption key.
CreateKeyDetails.Builder	copy(CreateKeyDetails model)
CreateKeyDetails.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
CreateKeyDetails.Builder	displayName(String displayName) A user-friendly name for the key.
CreateKeyDetails.Builder	externalKeyReference(ExternalKeyReference externalKeyReference)
CreateKeyDetails.Builder	freeformTags(Map<String,String> freeformTags) Free-form tags for this resource.
CreateKeyDetails.Builder	isAutoRotationEnabled(Boolean isAutoRotationEnabled) A parameter specifying whether the auto key rotation is enabled or not.
CreateKeyDetails.Builder	keyShape(KeyShape keyShape)
CreateKeyDetails.Builder	protectionMode(CreateKeyDetails.ProtectionMode protectionMode) The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public CreateKeyDetails.Builder compartmentId(String compartmentId)

The OCID of the compartment where you want to create the master encryption key.

Parameters:

compartmentId - the value to set

Returns:

this builder

definedTags

public CreateKeyDetails.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Parameters:

definedTags - the value to set

Returns:

this builder

displayName

public CreateKeyDetails.Builder displayName(String displayName)

A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Parameters:

displayName - the value to set

Returns:

this builder

freeformTags

public CreateKeyDetails.Builder freeformTags(Map<String,String> freeformTags)

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Parameters:

freeformTags - the value to set

Returns:

this builder

keyShape

public CreateKeyDetails.Builder keyShape(KeyShape keyShape)

isAutoRotationEnabled

public CreateKeyDetails.Builder isAutoRotationEnabled(Boolean isAutoRotationEnabled)

A parameter specifying whether the auto key rotation is enabled or not.

Parameters:

isAutoRotationEnabled - the value to set

Returns:

this builder

autoKeyRotationDetails

public CreateKeyDetails.Builder autoKeyRotationDetails(AutoKeyRotationDetails autoKeyRotationDetails)

protectionMode

public CreateKeyDetails.Builder protectionMode(CreateKeyDetails.ProtectionMode protectionMode)

The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault’s RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key’s protection mode is set to HSM. You can’t change a key’s protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer’s external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.

Parameters:

protectionMode - the value to set

Returns:

this builder

externalKeyReference

public CreateKeyDetails.Builder externalKeyReference(ExternalKeyReference externalKeyReference)

build

public CreateKeyDetails build()

copy

public CreateKeyDetails.Builder copy(CreateKeyDetails model)