- alias-attributes-builder
- alias-builder
- alias-props-builder
- build-alias-attributes-builder
- build-alias-builder
- build-alias-props-builder
- build-cfn-alias-builder
- build-cfn-alias-props-builder
- build-cfn-key-builder
- build-cfn-key-props-builder
- build-cfn-replica-key-builder
- build-cfn-replica-key-props-builder
- build-key-builder
- build-key-lookup-options-builder
- build-key-props-builder
- cfn-alias-builder
- cfn-alias-props-builder
- cfn-key-builder
- cfn-key-props-builder
- cfn-replica-key-builder
- cfn-replica-key-props-builder
- key-builder
- key-lookup-options-builder
- key-props-builder
- key-spec
- key-usage
cdk.api.services.kms
Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.kms package.
Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.kms package.
alias-attributes-builderclj
(alias-attributes-builder id config)Creates a AliasAttributes$Builder instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `AliasAttributes$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
alias-builderclj
(alias-builder scope id config)Creates a Alias$Builder instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `Alias$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
alias-props-builderclj
(alias-props-builder id config)Creates a AliasProps$Builder instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `AliasProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
build-alias-attributes-builderclj
(build-alias-attributes-builder builder id config)The build-alias-attributes-builder function updates a AliasAttributes$Builder instance using the provided configuration. The function takes the AliasAttributes$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
aliasName | java.lang.String | cdk.support/lookup-entry | :alias-name |
aliasTargetKey | software.amazon.awscdk.services.kms.IKey | cdk.support/lookup-entry | :alias-target-key |
The build-alias-attributes-builder function updates a AliasAttributes$Builder instance using the provided configuration. The function takes the AliasAttributes$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `aliasName` | java.lang.String | [[cdk.support/lookup-entry]] | `:alias-name` | | `aliasTargetKey` | software.amazon.awscdk.services.kms.IKey | [[cdk.support/lookup-entry]] | `:alias-target-key` |
build-alias-builderclj
(build-alias-builder builder id config)The build-alias-builder function updates a Alias$Builder instance using the provided configuration. The function takes the Alias$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
aliasName | java.lang.String | cdk.support/lookup-entry | :alias-name |
removalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :removal-policy |
targetKey | software.amazon.awscdk.services.kms.IKey | cdk.support/lookup-entry | :target-key |
The build-alias-builder function updates a Alias$Builder instance using the provided configuration. The function takes the Alias$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `aliasName` | java.lang.String | [[cdk.support/lookup-entry]] | `:alias-name` | | `removalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:removal-policy` | | `targetKey` | software.amazon.awscdk.services.kms.IKey | [[cdk.support/lookup-entry]] | `:target-key` |
build-alias-props-builderclj
(build-alias-props-builder builder id config)The build-alias-props-builder function updates a AliasProps$Builder instance using the provided configuration. The function takes the AliasProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
aliasName | java.lang.String | cdk.support/lookup-entry | :alias-name |
removalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :removal-policy |
targetKey | software.amazon.awscdk.services.kms.IKey | cdk.support/lookup-entry | :target-key |
The build-alias-props-builder function updates a AliasProps$Builder instance using the provided configuration. The function takes the AliasProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `aliasName` | java.lang.String | [[cdk.support/lookup-entry]] | `:alias-name` | | `removalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:removal-policy` | | `targetKey` | software.amazon.awscdk.services.kms.IKey | [[cdk.support/lookup-entry]] | `:target-key` |
build-cfn-alias-builderclj
(build-cfn-alias-builder builder id config)The build-cfn-alias-builder function updates a CfnAlias$Builder instance using the provided configuration. The function takes the CfnAlias$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
aliasName | java.lang.String | cdk.support/lookup-entry | :alias-name |
targetKeyId | java.lang.String | cdk.support/lookup-entry | :target-key-id |
The build-cfn-alias-builder function updates a CfnAlias$Builder instance using the provided configuration. The function takes the CfnAlias$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `aliasName` | java.lang.String | [[cdk.support/lookup-entry]] | `:alias-name` | | `targetKeyId` | java.lang.String | [[cdk.support/lookup-entry]] | `:target-key-id` |
build-cfn-alias-props-builderclj
(build-cfn-alias-props-builder builder id config)The build-cfn-alias-props-builder function updates a CfnAliasProps$Builder instance using the provided configuration. The function takes the CfnAliasProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
aliasName | java.lang.String | cdk.support/lookup-entry | :alias-name |
targetKeyId | java.lang.String | cdk.support/lookup-entry | :target-key-id |
The build-cfn-alias-props-builder function updates a CfnAliasProps$Builder instance using the provided configuration. The function takes the CfnAliasProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `aliasName` | java.lang.String | [[cdk.support/lookup-entry]] | `:alias-name` | | `targetKeyId` | java.lang.String | [[cdk.support/lookup-entry]] | `:target-key-id` |
build-cfn-key-builderclj
(build-cfn-key-builder builder id config)The build-cfn-key-builder function updates a CfnKey$Builder instance using the provided configuration. The function takes the CfnKey$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
bypassPolicyLockoutSafetyCheck | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :bypass-policy-lockout-safety-check |
description | java.lang.String | cdk.support/lookup-entry | :description |
enableKeyRotation | java.lang.Boolean | cdk.support/lookup-entry | :enable-key-rotation |
enabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :enabled |
keyPolicy | java.lang.Object | cdk.support/lookup-entry | :key-policy |
keySpec | java.lang.String | cdk.support/lookup-entry | :key-spec |
keyUsage | java.lang.String | cdk.support/lookup-entry | :key-usage |
multiRegion | java.lang.Boolean | cdk.support/lookup-entry | :multi-region |
origin | java.lang.String | cdk.support/lookup-entry | :origin |
pendingWindowInDays | java.lang.Number | cdk.support/lookup-entry | :pending-window-in-days |
rotationPeriodInDays | java.lang.Number | cdk.support/lookup-entry | :rotation-period-in-days |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-key-builder function updates a CfnKey$Builder instance using the provided configuration. The function takes the CfnKey$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `bypassPolicyLockoutSafetyCheck` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:bypass-policy-lockout-safety-check` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enableKeyRotation` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enable-key-rotation` | | `enabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:enabled` | | `keyPolicy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:key-policy` | | `keySpec` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-spec` | | `keyUsage` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-usage` | | `multiRegion` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:multi-region` | | `origin` | java.lang.String | [[cdk.support/lookup-entry]] | `:origin` | | `pendingWindowInDays` | java.lang.Number | [[cdk.support/lookup-entry]] | `:pending-window-in-days` | | `rotationPeriodInDays` | java.lang.Number | [[cdk.support/lookup-entry]] | `:rotation-period-in-days` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
build-cfn-key-props-builderclj
(build-cfn-key-props-builder builder id config)The build-cfn-key-props-builder function updates a CfnKeyProps$Builder instance using the provided configuration. The function takes the CfnKeyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
bypassPolicyLockoutSafetyCheck | java.lang.Boolean | cdk.support/lookup-entry | :bypass-policy-lockout-safety-check |
description | java.lang.String | cdk.support/lookup-entry | :description |
enableKeyRotation | java.lang.Boolean | cdk.support/lookup-entry | :enable-key-rotation |
enabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :enabled |
keyPolicy | java.lang.Object | cdk.support/lookup-entry | :key-policy |
keySpec | java.lang.String | cdk.support/lookup-entry | :key-spec |
keyUsage | java.lang.String | cdk.support/lookup-entry | :key-usage |
multiRegion | java.lang.Boolean | cdk.support/lookup-entry | :multi-region |
origin | java.lang.String | cdk.support/lookup-entry | :origin |
pendingWindowInDays | java.lang.Number | cdk.support/lookup-entry | :pending-window-in-days |
rotationPeriodInDays | java.lang.Number | cdk.support/lookup-entry | :rotation-period-in-days |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-key-props-builder function updates a CfnKeyProps$Builder instance using the provided configuration. The function takes the CfnKeyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `bypassPolicyLockoutSafetyCheck` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:bypass-policy-lockout-safety-check` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enableKeyRotation` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enable-key-rotation` | | `enabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:enabled` | | `keyPolicy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:key-policy` | | `keySpec` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-spec` | | `keyUsage` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-usage` | | `multiRegion` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:multi-region` | | `origin` | java.lang.String | [[cdk.support/lookup-entry]] | `:origin` | | `pendingWindowInDays` | java.lang.Number | [[cdk.support/lookup-entry]] | `:pending-window-in-days` | | `rotationPeriodInDays` | java.lang.Number | [[cdk.support/lookup-entry]] | `:rotation-period-in-days` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
build-cfn-replica-key-builderclj
(build-cfn-replica-key-builder builder id config)The build-cfn-replica-key-builder function updates a CfnReplicaKey$Builder instance using the provided configuration. The function takes the CfnReplicaKey$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
enabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :enabled |
keyPolicy | java.lang.Object | cdk.support/lookup-entry | :key-policy |
pendingWindowInDays | java.lang.Number | cdk.support/lookup-entry | :pending-window-in-days |
primaryKeyArn | java.lang.String | cdk.support/lookup-entry | :primary-key-arn |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-replica-key-builder function updates a CfnReplicaKey$Builder instance using the provided configuration. The function takes the CfnReplicaKey$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:enabled` | | `keyPolicy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:key-policy` | | `pendingWindowInDays` | java.lang.Number | [[cdk.support/lookup-entry]] | `:pending-window-in-days` | | `primaryKeyArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:primary-key-arn` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
build-cfn-replica-key-props-builderclj
(build-cfn-replica-key-props-builder builder id config)The build-cfn-replica-key-props-builder function updates a CfnReplicaKeyProps$Builder instance using the provided configuration. The function takes the CfnReplicaKeyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
keyPolicy | java.lang.Object | cdk.support/lookup-entry | :key-policy |
pendingWindowInDays | java.lang.Number | cdk.support/lookup-entry | :pending-window-in-days |
primaryKeyArn | java.lang.String | cdk.support/lookup-entry | :primary-key-arn |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-replica-key-props-builder function updates a CfnReplicaKeyProps$Builder instance using the provided configuration. The function takes the CfnReplicaKeyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `keyPolicy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:key-policy` | | `pendingWindowInDays` | java.lang.Number | [[cdk.support/lookup-entry]] | `:pending-window-in-days` | | `primaryKeyArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:primary-key-arn` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
build-key-builderclj
(build-key-builder builder id config)The build-key-builder function updates a Key$Builder instance using the provided configuration. The function takes the Key$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
admins | java.util.List | cdk.support/lookup-entry | :admins |
alias | java.lang.String | cdk.support/lookup-entry | :alias |
description | java.lang.String | cdk.support/lookup-entry | :description |
enableKeyRotation | java.lang.Boolean | cdk.support/lookup-entry | :enable-key-rotation |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
keySpec | software.amazon.awscdk.services.kms.KeySpec | cdk.api.services.kms/key-spec | :key-spec |
keyUsage | software.amazon.awscdk.services.kms.KeyUsage | cdk.api.services.kms/key-usage | :key-usage |
pendingWindow | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :pending-window |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
removalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :removal-policy |
rotationPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :rotation-period |
The build-key-builder function updates a Key$Builder instance using the provided configuration. The function takes the Key$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `admins` | java.util.List | [[cdk.support/lookup-entry]] | `:admins` | | `alias` | java.lang.String | [[cdk.support/lookup-entry]] | `:alias` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enableKeyRotation` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enable-key-rotation` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `keySpec` | software.amazon.awscdk.services.kms.KeySpec | [[cdk.api.services.kms/key-spec]] | `:key-spec` | | `keyUsage` | software.amazon.awscdk.services.kms.KeyUsage | [[cdk.api.services.kms/key-usage]] | `:key-usage` | | `pendingWindow` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:pending-window` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `removalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:removal-policy` | | `rotationPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:rotation-period` |
build-key-lookup-options-builderclj
(build-key-lookup-options-builder builder id config)The build-key-lookup-options-builder function updates a KeyLookupOptions$Builder instance using the provided configuration. The function takes the KeyLookupOptions$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
aliasName | java.lang.String | cdk.support/lookup-entry | :alias-name |
The build-key-lookup-options-builder function updates a KeyLookupOptions$Builder instance using the provided configuration. The function takes the KeyLookupOptions$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `aliasName` | java.lang.String | [[cdk.support/lookup-entry]] | `:alias-name` |
build-key-props-builderclj
(build-key-props-builder builder id config)The build-key-props-builder function updates a KeyProps$Builder instance using the provided configuration. The function takes the KeyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
| Field | DataType | Lookup Function | Data Key |
|---|---|---|---|
admins | java.util.List | cdk.support/lookup-entry | :admins |
alias | java.lang.String | cdk.support/lookup-entry | :alias |
description | java.lang.String | cdk.support/lookup-entry | :description |
enableKeyRotation | java.lang.Boolean | cdk.support/lookup-entry | :enable-key-rotation |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
keySpec | software.amazon.awscdk.services.kms.KeySpec | cdk.api.services.kms/key-spec | :key-spec |
keyUsage | software.amazon.awscdk.services.kms.KeyUsage | cdk.api.services.kms/key-usage | :key-usage |
pendingWindow | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :pending-window |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
removalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :removal-policy |
rotationPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :rotation-period |
The build-key-props-builder function updates a KeyProps$Builder instance using the provided configuration. The function takes the KeyProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `admins` | java.util.List | [[cdk.support/lookup-entry]] | `:admins` | | `alias` | java.lang.String | [[cdk.support/lookup-entry]] | `:alias` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enableKeyRotation` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enable-key-rotation` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `keySpec` | software.amazon.awscdk.services.kms.KeySpec | [[cdk.api.services.kms/key-spec]] | `:key-spec` | | `keyUsage` | software.amazon.awscdk.services.kms.KeyUsage | [[cdk.api.services.kms/key-usage]] | `:key-usage` | | `pendingWindow` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:pending-window` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `removalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:removal-policy` | | `rotationPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:rotation-period` |
cfn-alias-builderclj
(cfn-alias-builder scope id config)Creates a CfnAlias$Builder instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `CfnAlias$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
cfn-alias-props-builderclj
(cfn-alias-props-builder id config)Creates a CfnAliasProps$Builder instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `CfnAliasProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
cfn-key-builderclj
(cfn-key-builder scope id config)Creates a CfnKey$Builder instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `CfnKey$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
cfn-key-props-builderclj
(cfn-key-props-builder id config)Creates a CfnKeyProps$Builder instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `CfnKeyProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
cfn-replica-key-builderclj
(cfn-replica-key-builder scope id config)Creates a CfnReplicaKey$Builder instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `CfnReplicaKey$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
cfn-replica-key-props-builderclj
(cfn-replica-key-props-builder id config)Creates a CfnReplicaKeyProps$Builder instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `CfnReplicaKeyProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
key-builderclj
(key-builder scope id config)Creates a Key$Builder instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| scope | software.constructs.Construct | The parent scope construct of the object being built. |
| id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `Key$Builder` instance using a scope and ID, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | scope | software.constructs.Construct | The parent scope construct of the object being built. | | id | String or Keyword or Symbol | Value to use as both the ID of the object being build and the namespace when looking up configuration values. | | config | map | Data configuration |
key-lookup-options-builderclj
(key-lookup-options-builder id config)Creates a KeyLookupOptions$Builder instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `KeyLookupOptions$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
key-props-builderclj
(key-props-builder id config)Creates a KeyProps$Builder instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments:
| Argument | DataType | Description |
|---|---|---|
| id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. |
| config | map | Data configuration |
Creates a `KeyProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
key-specclj
(key-spec config id item-key)The key-spec function data interprets values in the provided config data into a
KeySpec instance. This simplifies the use of keywords in place of actual enum values in
the configuration provided to builders. The value is found using the cdk.support/lookup-entry
function on the data with the provided namespace id and item-key. The found value is interpretted as follows:
- instance of
KeySpec- the value is returned. - is
:hmac-512-KeySpec/HMAC_512is returned - is
:ecc-nist-p384-KeySpec/ECC_NIST_P384is returned - is
:rsa-3072-KeySpec/RSA_3072is returned - is
:hmac-384-KeySpec/HMAC_384is returned - is
:sm2-KeySpec/SM2is returned - is
:rsa-2048-KeySpec/RSA_2048is returned - is
:hmac-256-KeySpec/HMAC_256is returned - is
:ecc-secg-p256k1-KeySpec/ECC_SECG_P256K1is returned - is
:rsa-4096-KeySpec/RSA_4096is returned - is
:hmac-224-KeySpec/HMAC_224is returned - is
:ecc-nist-p521-KeySpec/ECC_NIST_P521is returned - is
:ecc-nist-p256-KeySpec/ECC_NIST_P256is returned - is
:symmetric-default-KeySpec/SYMMETRIC_DEFAULTis returned
If a value is not found or matches the above criteria, nil is returned.
The `key-spec` function data interprets values in the provided config data into a `KeySpec` instance. This simplifies the use of keywords in place of actual enum values in the configuration provided to builders. The value is found using the `cdk.support/lookup-entry` function on the data with the provided namespace id and item-key. The found value is interpretted as follows: * instance of `KeySpec` - the value is returned. * is `:hmac-512` - `KeySpec/HMAC_512` is returned * is `:ecc-nist-p384` - `KeySpec/ECC_NIST_P384` is returned * is `:rsa-3072` - `KeySpec/RSA_3072` is returned * is `:hmac-384` - `KeySpec/HMAC_384` is returned * is `:sm2` - `KeySpec/SM2` is returned * is `:rsa-2048` - `KeySpec/RSA_2048` is returned * is `:hmac-256` - `KeySpec/HMAC_256` is returned * is `:ecc-secg-p256k1` - `KeySpec/ECC_SECG_P256K1` is returned * is `:rsa-4096` - `KeySpec/RSA_4096` is returned * is `:hmac-224` - `KeySpec/HMAC_224` is returned * is `:ecc-nist-p521` - `KeySpec/ECC_NIST_P521` is returned * is `:ecc-nist-p256` - `KeySpec/ECC_NIST_P256` is returned * is `:symmetric-default` - `KeySpec/SYMMETRIC_DEFAULT` is returned If a value is not found or matches the above criteria, nil is returned.
key-usageclj
(key-usage config id item-key)The key-usage function data interprets values in the provided config data into a
KeyUsage instance. This simplifies the use of keywords in place of actual enum values in
the configuration provided to builders. The value is found using the cdk.support/lookup-entry
function on the data with the provided namespace id and item-key. The found value is interpretted as follows:
- instance of
KeyUsage- the value is returned. - is
:encrypt-decrypt-KeyUsage/ENCRYPT_DECRYPTis returned - is
:generate-verify-mac-KeyUsage/GENERATE_VERIFY_MACis returned - is
:sign-verify-KeyUsage/SIGN_VERIFYis returned
If a value is not found or matches the above criteria, nil is returned.
The `key-usage` function data interprets values in the provided config data into a `KeyUsage` instance. This simplifies the use of keywords in place of actual enum values in the configuration provided to builders. The value is found using the `cdk.support/lookup-entry` function on the data with the provided namespace id and item-key. The found value is interpretted as follows: * instance of `KeyUsage` - the value is returned. * is `:encrypt-decrypt` - `KeyUsage/ENCRYPT_DECRYPT` is returned * is `:generate-verify-mac` - `KeyUsage/GENERATE_VERIFY_MAC` is returned * is `:sign-verify` - `KeyUsage/SIGN_VERIFY` is returned If a value is not found or matches the above criteria, nil is returned.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close