Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.kinesis package.
Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.kinesis package.
(build-cfn-stream-builder builder id config)
The build-cfn-stream-builder function updates a CfnStream$Builder instance using the provided configuration. The function takes the CfnStream$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 |
---|---|---|---|
name | java.lang.String | cdk.support/lookup-entry | :name |
retentionPeriodHours | java.lang.Number | cdk.support/lookup-entry | :retention-period-hours |
shardCount | java.lang.Number | cdk.support/lookup-entry | :shard-count |
streamEncryption | software.amazon.awscdk.services.kinesis.CfnStream$StreamEncryptionProperty | cdk.support/lookup-entry | :stream-encryption |
streamModeDetails | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :stream-mode-details |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-stream-builder function updates a CfnStream$Builder instance using the provided configuration. The function takes the CfnStream$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 | |---|---|---|---| | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `retentionPeriodHours` | java.lang.Number | [[cdk.support/lookup-entry]] | `:retention-period-hours` | | `shardCount` | java.lang.Number | [[cdk.support/lookup-entry]] | `:shard-count` | | `streamEncryption` | software.amazon.awscdk.services.kinesis.CfnStream$StreamEncryptionProperty | [[cdk.support/lookup-entry]] | `:stream-encryption` | | `streamModeDetails` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:stream-mode-details` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-cfn-stream-consumer-builder builder id config)
The build-cfn-stream-consumer-builder function updates a CfnStreamConsumer$Builder instance using the provided configuration. The function takes the CfnStreamConsumer$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 |
---|---|---|---|
consumerName | java.lang.String | cdk.support/lookup-entry | :consumer-name |
streamArn | java.lang.String | cdk.support/lookup-entry | :stream-arn |
The build-cfn-stream-consumer-builder function updates a CfnStreamConsumer$Builder instance using the provided configuration. The function takes the CfnStreamConsumer$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 | |---|---|---|---| | `consumerName` | java.lang.String | [[cdk.support/lookup-entry]] | `:consumer-name` | | `streamArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:stream-arn` |
(build-cfn-stream-consumer-props-builder builder id config)
The build-cfn-stream-consumer-props-builder function updates a CfnStreamConsumerProps$Builder instance using the provided configuration. The function takes the CfnStreamConsumerProps$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 |
---|---|---|---|
consumerName | java.lang.String | cdk.support/lookup-entry | :consumer-name |
streamArn | java.lang.String | cdk.support/lookup-entry | :stream-arn |
The build-cfn-stream-consumer-props-builder function updates a CfnStreamConsumerProps$Builder instance using the provided configuration. The function takes the CfnStreamConsumerProps$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 | |---|---|---|---| | `consumerName` | java.lang.String | [[cdk.support/lookup-entry]] | `:consumer-name` | | `streamArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:stream-arn` |
(build-cfn-stream-props-builder builder id config)
The build-cfn-stream-props-builder function updates a CfnStreamProps$Builder instance using the provided configuration. The function takes the CfnStreamProps$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 |
---|---|---|---|
name | java.lang.String | cdk.support/lookup-entry | :name |
retentionPeriodHours | java.lang.Number | cdk.support/lookup-entry | :retention-period-hours |
shardCount | java.lang.Number | cdk.support/lookup-entry | :shard-count |
streamEncryption | software.amazon.awscdk.services.kinesis.CfnStream$StreamEncryptionProperty | cdk.support/lookup-entry | :stream-encryption |
streamModeDetails | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :stream-mode-details |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-stream-props-builder function updates a CfnStreamProps$Builder instance using the provided configuration. The function takes the CfnStreamProps$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 | |---|---|---|---| | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `retentionPeriodHours` | java.lang.Number | [[cdk.support/lookup-entry]] | `:retention-period-hours` | | `shardCount` | java.lang.Number | [[cdk.support/lookup-entry]] | `:shard-count` | | `streamEncryption` | software.amazon.awscdk.services.kinesis.CfnStream$StreamEncryptionProperty | [[cdk.support/lookup-entry]] | `:stream-encryption` | | `streamModeDetails` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:stream-mode-details` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-cfn-stream-stream-encryption-property-builder builder id config)
The build-cfn-stream-stream-encryption-property-builder function updates a CfnStream$StreamEncryptionProperty$Builder instance using the provided configuration. The function takes the CfnStream$StreamEncryptionProperty$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 |
---|---|---|---|
encryptionType | java.lang.String | cdk.support/lookup-entry | :encryption-type |
keyId | java.lang.String | cdk.support/lookup-entry | :key-id |
The build-cfn-stream-stream-encryption-property-builder function updates a CfnStream$StreamEncryptionProperty$Builder instance using the provided configuration. The function takes the CfnStream$StreamEncryptionProperty$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 | |---|---|---|---| | `encryptionType` | java.lang.String | [[cdk.support/lookup-entry]] | `:encryption-type` | | `keyId` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-id` |
(build-cfn-stream-stream-mode-details-property-builder builder id config)
The build-cfn-stream-stream-mode-details-property-builder function updates a CfnStream$StreamModeDetailsProperty$Builder instance using the provided configuration. The function takes the CfnStream$StreamModeDetailsProperty$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 |
---|---|---|---|
streamMode | java.lang.String | cdk.support/lookup-entry | :stream-mode |
The build-cfn-stream-stream-mode-details-property-builder function updates a CfnStream$StreamModeDetailsProperty$Builder instance using the provided configuration. The function takes the CfnStream$StreamModeDetailsProperty$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 | |---|---|---|---| | `streamMode` | java.lang.String | [[cdk.support/lookup-entry]] | `:stream-mode` |
(build-stream-attributes-builder builder id config)
The build-stream-attributes-builder function updates a StreamAttributes$Builder instance using the provided configuration. The function takes the StreamAttributes$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 |
---|---|---|---|
encryptionKey | software.amazon.awscdk.services.kms.IKey | cdk.support/lookup-entry | :encryption-key |
streamArn | java.lang.String | cdk.support/lookup-entry | :stream-arn |
The build-stream-attributes-builder function updates a StreamAttributes$Builder instance using the provided configuration. The function takes the StreamAttributes$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 | |---|---|---|---| | `encryptionKey` | software.amazon.awscdk.services.kms.IKey | [[cdk.support/lookup-entry]] | `:encryption-key` | | `streamArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:stream-arn` |
(build-stream-builder builder id config)
The build-stream-builder function updates a Stream$Builder instance using the provided configuration. The function takes the Stream$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 |
---|---|---|---|
encryption | software.amazon.awscdk.services.kinesis.StreamEncryption | cdk.api.services.kinesis/stream-encryption | :encryption |
encryptionKey | software.amazon.awscdk.services.kms.IKey | cdk.support/lookup-entry | :encryption-key |
removalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :removal-policy |
retentionPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :retention-period |
shardCount | java.lang.Number | cdk.support/lookup-entry | :shard-count |
streamMode | software.amazon.awscdk.services.kinesis.StreamMode | cdk.api.services.kinesis/stream-mode | :stream-mode |
streamName | java.lang.String | cdk.support/lookup-entry | :stream-name |
The build-stream-builder function updates a Stream$Builder instance using the provided configuration. The function takes the Stream$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 | |---|---|---|---| | `encryption` | software.amazon.awscdk.services.kinesis.StreamEncryption | [[cdk.api.services.kinesis/stream-encryption]] | `:encryption` | | `encryptionKey` | software.amazon.awscdk.services.kms.IKey | [[cdk.support/lookup-entry]] | `:encryption-key` | | `removalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:removal-policy` | | `retentionPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:retention-period` | | `shardCount` | java.lang.Number | [[cdk.support/lookup-entry]] | `:shard-count` | | `streamMode` | software.amazon.awscdk.services.kinesis.StreamMode | [[cdk.api.services.kinesis/stream-mode]] | `:stream-mode` | | `streamName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stream-name` |
(build-stream-props-builder builder id config)
The build-stream-props-builder function updates a StreamProps$Builder instance using the provided configuration. The function takes the StreamProps$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 |
---|---|---|---|
encryption | software.amazon.awscdk.services.kinesis.StreamEncryption | cdk.api.services.kinesis/stream-encryption | :encryption |
encryptionKey | software.amazon.awscdk.services.kms.IKey | cdk.support/lookup-entry | :encryption-key |
removalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :removal-policy |
retentionPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :retention-period |
shardCount | java.lang.Number | cdk.support/lookup-entry | :shard-count |
streamMode | software.amazon.awscdk.services.kinesis.StreamMode | cdk.api.services.kinesis/stream-mode | :stream-mode |
streamName | java.lang.String | cdk.support/lookup-entry | :stream-name |
The build-stream-props-builder function updates a StreamProps$Builder instance using the provided configuration. The function takes the StreamProps$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 | |---|---|---|---| | `encryption` | software.amazon.awscdk.services.kinesis.StreamEncryption | [[cdk.api.services.kinesis/stream-encryption]] | `:encryption` | | `encryptionKey` | software.amazon.awscdk.services.kms.IKey | [[cdk.support/lookup-entry]] | `:encryption-key` | | `removalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:removal-policy` | | `retentionPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:retention-period` | | `shardCount` | java.lang.Number | [[cdk.support/lookup-entry]] | `:shard-count` | | `streamMode` | software.amazon.awscdk.services.kinesis.StreamMode | [[cdk.api.services.kinesis/stream-mode]] | `:stream-mode` | | `streamName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stream-name` |
(cfn-stream-builder scope id config)
Creates a CfnStream$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 `CfnStream$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-stream-consumer-builder scope id config)
Creates a CfnStreamConsumer$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 `CfnStreamConsumer$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-stream-consumer-props-builder id config)
Creates a CfnStreamConsumerProps$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 `CfnStreamConsumerProps$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-stream-props-builder id config)
Creates a CfnStreamProps$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 `CfnStreamProps$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-stream-stream-encryption-property-builder id config)
Creates a CfnStream$StreamEncryptionProperty$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 `CfnStream$StreamEncryptionProperty$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-stream-stream-mode-details-property-builder id config)
Creates a CfnStream$StreamModeDetailsProperty$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 `CfnStream$StreamModeDetailsProperty$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 |
(stream-attributes-builder id config)
Creates a StreamAttributes$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 `StreamAttributes$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 |
(stream-builder scope id config)
Creates a Stream$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 `Stream$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 |
(stream-encryption config id item-key)
The stream-encryption
function data interprets values in the provided config data into a
StreamEncryption
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:
StreamEncryption
- the value is returned.:kms
- StreamEncryption/KMS
is returned:unencrypted
- StreamEncryption/UNENCRYPTED
is returned:managed
- StreamEncryption/MANAGED
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `stream-encryption` function data interprets values in the provided config data into a `StreamEncryption` 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 `StreamEncryption` - the value is returned. * is `:kms` - `StreamEncryption/KMS` is returned * is `:unencrypted` - `StreamEncryption/UNENCRYPTED` is returned * is `:managed` - `StreamEncryption/MANAGED` is returned If a value is not found or matches the above criteria, nil is returned.
(stream-mode config id item-key)
The stream-mode
function data interprets values in the provided config data into a
StreamMode
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:
StreamMode
- the value is returned.:provisioned
- StreamMode/PROVISIONED
is returned:on-demand
- StreamMode/ON_DEMAND
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `stream-mode` function data interprets values in the provided config data into a `StreamMode` 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 `StreamMode` - the value is returned. * is `:provisioned` - `StreamMode/PROVISIONED` is returned * is `:on-demand` - `StreamMode/ON_DEMAND` is returned If a value is not found or matches the above criteria, nil is returned.
(stream-props-builder id config)
Creates a StreamProps$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 `StreamProps$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 |
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close