KMSKeyBuilder (FsCDK)

KMSKeyBuilder Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`KMSKeyBuilder(name)` Full Usage: `KMSKeyBuilder(name)` Parameters: name : `string` Returns: `KMSKeyBuilder`	name : `string` Returns: `KMSKeyBuilder`


                
                  
                    
                      KMSKeyBuilder(name)

Full Usage: KMSKeyBuilder(name)

Parameters:

name : string

Returns: KMSKeyBuilder

name : string

Returns: KMSKeyBuilder

Instance members

Instance member	Description
`admissionPrincipal principal` Full Usage: `admissionPrincipal principal` Parameters: principal : `IPrincipal` - The IAM principal. Returns: `KMSKeyConfig`	Sets the principal that can administer the key. principal : `IPrincipal` The IAM principal. Returns: `KMSKeyConfig`
`alias alias` Full Usage: `alias alias` Parameters: alias : `string` - The key alias. Returns: `KMSKeyConfig`	Sets an alias for the KMS key (e.g., "alias/my-app-key"). alias : `string` The key alias. Returns: `KMSKeyConfig`
`this.Combine` Full Usage: `this.Combine` Parameters: state1 : `KMSKeyConfig` state2 : `KMSKeyConfig` Returns: `KMSKeyConfig`	state1 : `KMSKeyConfig` state2 : `KMSKeyConfig` Returns: `KMSKeyConfig`
`constructId id` Full Usage: `constructId id` Parameters: id : `string` - The construct ID. Returns: `KMSKeyConfig`	Sets the construct ID for the KMS key. id : `string` The construct ID. Returns: `KMSKeyConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> KMSKeyConfig` Returns: `KMSKeyConfig` Modifiers: inline	f : `unit -> KMSKeyConfig` Returns: `KMSKeyConfig`
`description description` Full Usage: `description description` Parameters: description : `string` - Human-readable description. Returns: `KMSKeyConfig`	Sets the description for the KMS key. description : `string` Human-readable description. Returns: `KMSKeyConfig`
`disableKeyRotation` Full Usage: `disableKeyRotation` Returns: `KMSKeyConfig`	Disables automatic key rotation (not recommended). Returns: `KMSKeyConfig`
`enableKeyRotation` Full Usage: `enableKeyRotation` Returns: `KMSKeyConfig`	Enables automatic key rotation (recommended for security). Returns: `KMSKeyConfig`
`enabled enabled` Full Usage: `enabled enabled` Parameters: enabled : `bool` - Enable or disable the key. Returns: `KMSKeyConfig`	Sets whether the key is enabled (default: true). enabled : `bool` Enable or disable the key. Returns: `KMSKeyConfig`
`this.For` Full Usage: `this.For` Parameters: config : `KMSKeyConfig` f : `unit -> KMSKeyConfig` Returns: `KMSKeyConfig` Modifiers: inline	config : `KMSKeyConfig` f : `unit -> KMSKeyConfig` Returns: `KMSKeyConfig`
`keySpec spec` Full Usage: `keySpec spec` Parameters: spec : `KeySpec` - The key specification. Returns: `KMSKeyConfig`	Sets the key spec (SYMMETRIC_DEFAULT, RSA_2048, etc.). spec : `KeySpec` The key specification. Returns: `KMSKeyConfig`
`keyUsage usage` Full Usage: `keyUsage usage` Parameters: usage : `KeyUsage` - The key usage. Returns: `KMSKeyConfig`	Sets the key usage (ENCRYPT_DECRYPT, SIGN_VERIFY, GENERATE_VERIFY_MAC). usage : `KeyUsage` The key usage. Returns: `KMSKeyConfig`
`pendingWindow window` Full Usage: `pendingWindow window` Parameters: window : `Duration` - The pending window duration. Returns: `KMSKeyConfig`	Sets the pending window for key deletion (7-30 days). window : `Duration` The pending window duration. Returns: `KMSKeyConfig`
`policy policy` Full Usage: `policy policy` Parameters: policy : `PolicyDocument` - The key policy document. Returns: `KMSKeyConfig`	Sets a custom key policy. policy : `PolicyDocument` The key policy document. Returns: `KMSKeyConfig`
`removalPolicy policy` Full Usage: `removalPolicy policy` Parameters: policy : `RemovalPolicy` - The removal policy. Returns: `KMSKeyConfig`	Sets the removal policy (RETAIN, DESTROY, SNAPSHOT). policy : `RemovalPolicy` The removal policy. Returns: `KMSKeyConfig`
`this.Run` Full Usage: `this.Run` Parameters: config : `KMSKeyConfig` Returns: `KMSKeySpec`	config : `KMSKeyConfig` Returns: `KMSKeySpec`
`this.Yield` Full Usage: `this.Yield` Parameters: () : `unit` Returns: `KMSKeyConfig`	() : `unit` Returns: `KMSKeyConfig`
`this.Zero` Full Usage: `this.Zero` Returns: `KMSKeyConfig`	Returns: `KMSKeyConfig`