Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.synthetics package.
Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.synthetics package.
(artifacts-bucket-location-builder id config)
Creates a ArtifactsBucketLocation$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 `ArtifactsBucketLocation$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 |
(asset-code-builder path id config)
Creates a AssetCode$Builder
instance using provided forms, applies the data configuration, then builds it. Takes the following arguments:
Create Form: _[java.lang.String] | Argument | DataType | Description | |---|---|---| | path | java.lang.String | | | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
Creates a `AssetCode$Builder` instance using provided forms, applies the data configuration, then builds it. Takes the following arguments: __Create Form:__ ____[java.lang.String]___ | Argument | DataType | Description | |---|---|---| | path | java.lang.String | | | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(build-artifacts-bucket-location-builder builder id config)
The build-artifacts-bucket-location-builder function updates a ArtifactsBucketLocation$Builder instance using the provided configuration. The function takes the ArtifactsBucketLocation$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 |
---|---|---|---|
bucket | software.amazon.awscdk.services.s3.IBucket | cdk.support/lookup-entry | :bucket |
prefix | java.lang.String | cdk.support/lookup-entry | :prefix |
The build-artifacts-bucket-location-builder function updates a ArtifactsBucketLocation$Builder instance using the provided configuration. The function takes the ArtifactsBucketLocation$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 | |---|---|---|---| | `bucket` | software.amazon.awscdk.services.s3.IBucket | [[cdk.support/lookup-entry]] | `:bucket` | | `prefix` | java.lang.String | [[cdk.support/lookup-entry]] | `:prefix` |
(build-asset-code-builder builder id config)
The build-asset-code-builder function updates a AssetCode$Builder instance using the provided configuration. The function takes the AssetCode$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 |
---|---|---|---|
assetHash | java.lang.String | cdk.support/lookup-entry | :asset-hash |
assetHashType | software.amazon.awscdk.AssetHashType | cdk.api/asset-hash-type | :asset-hash-type |
bundling | software.amazon.awscdk.BundlingOptions | cdk.support/lookup-entry | :bundling |
deployTime | java.lang.Boolean | cdk.support/lookup-entry | :deploy-time |
exclude | java.util.List | cdk.support/lookup-entry | :exclude |
followSymlinks | software.amazon.awscdk.SymlinkFollowMode | cdk.api/symlink-follow-mode | :follow-symlinks |
ignoreMode | software.amazon.awscdk.IgnoreMode | cdk.api/ignore-mode | :ignore-mode |
readers | java.util.List | cdk.support/lookup-entry | :readers |
The build-asset-code-builder function updates a AssetCode$Builder instance using the provided configuration. The function takes the AssetCode$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 | |---|---|---|---| | `assetHash` | java.lang.String | [[cdk.support/lookup-entry]] | `:asset-hash` | | `assetHashType` | software.amazon.awscdk.AssetHashType | [[cdk.api/asset-hash-type]] | `:asset-hash-type` | | `bundling` | software.amazon.awscdk.BundlingOptions | [[cdk.support/lookup-entry]] | `:bundling` | | `deployTime` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy-time` | | `exclude` | java.util.List | [[cdk.support/lookup-entry]] | `:exclude` | | `followSymlinks` | software.amazon.awscdk.SymlinkFollowMode | [[cdk.api/symlink-follow-mode]] | `:follow-symlinks` | | `ignoreMode` | software.amazon.awscdk.IgnoreMode | [[cdk.api/ignore-mode]] | `:ignore-mode` | | `readers` | java.util.List | [[cdk.support/lookup-entry]] | `:readers` |
(build-canary-builder builder id config)
The build-canary-builder function updates a Canary$Builder instance using the provided configuration. The function takes the Canary$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 |
---|---|---|---|
artifactsBucketLifecycleRules | java.util.List | cdk.support/lookup-entry | :artifacts-bucket-lifecycle-rules |
artifactsBucketLocation | software.amazon.awscdk.services.synthetics.ArtifactsBucketLocation | cdk.support/lookup-entry | :artifacts-bucket-location |
canaryName | java.lang.String | cdk.support/lookup-entry | :canary-name |
cleanup | software.amazon.awscdk.services.synthetics.Cleanup | cdk.api.services.synthetics/cleanup | :cleanup |
environmentVariables | java.util.Map | cdk.support/lookup-entry | :environment-variables |
failureRetentionPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :failure-retention-period |
role | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :role |
runtime | software.amazon.awscdk.services.synthetics.Runtime | cdk.support/lookup-entry | :runtime |
schedule | software.amazon.awscdk.services.synthetics.Schedule | cdk.support/lookup-entry | :schedule |
securityGroups | java.util.List | cdk.support/lookup-entry | :security-groups |
startAfterCreation | java.lang.Boolean | cdk.support/lookup-entry | :start-after-creation |
successRetentionPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :success-retention-period |
test | software.amazon.awscdk.services.synthetics.Test | cdk.support/lookup-entry | :test |
timeToLive | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :time-to-live |
vpc | software.amazon.awscdk.services.ec2.IVpc | cdk.support/lookup-entry | :vpc |
vpcSubnets | software.amazon.awscdk.services.ec2.SubnetSelection | cdk.support/lookup-entry | :vpc-subnets |
The build-canary-builder function updates a Canary$Builder instance using the provided configuration. The function takes the Canary$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 | |---|---|---|---| | `artifactsBucketLifecycleRules` | java.util.List | [[cdk.support/lookup-entry]] | `:artifacts-bucket-lifecycle-rules` | | `artifactsBucketLocation` | software.amazon.awscdk.services.synthetics.ArtifactsBucketLocation | [[cdk.support/lookup-entry]] | `:artifacts-bucket-location` | | `canaryName` | java.lang.String | [[cdk.support/lookup-entry]] | `:canary-name` | | `cleanup` | software.amazon.awscdk.services.synthetics.Cleanup | [[cdk.api.services.synthetics/cleanup]] | `:cleanup` | | `environmentVariables` | java.util.Map | [[cdk.support/lookup-entry]] | `:environment-variables` | | `failureRetentionPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:failure-retention-period` | | `role` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:role` | | `runtime` | software.amazon.awscdk.services.synthetics.Runtime | [[cdk.support/lookup-entry]] | `:runtime` | | `schedule` | software.amazon.awscdk.services.synthetics.Schedule | [[cdk.support/lookup-entry]] | `:schedule` | | `securityGroups` | java.util.List | [[cdk.support/lookup-entry]] | `:security-groups` | | `startAfterCreation` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:start-after-creation` | | `successRetentionPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:success-retention-period` | | `test` | software.amazon.awscdk.services.synthetics.Test | [[cdk.support/lookup-entry]] | `:test` | | `timeToLive` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:time-to-live` | | `vpc` | software.amazon.awscdk.services.ec2.IVpc | [[cdk.support/lookup-entry]] | `:vpc` | | `vpcSubnets` | software.amazon.awscdk.services.ec2.SubnetSelection | [[cdk.support/lookup-entry]] | `:vpc-subnets` |
(build-canary-props-builder builder id config)
The build-canary-props-builder function updates a CanaryProps$Builder instance using the provided configuration. The function takes the CanaryProps$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 |
---|---|---|---|
artifactsBucketLifecycleRules | java.util.List | cdk.support/lookup-entry | :artifacts-bucket-lifecycle-rules |
artifactsBucketLocation | software.amazon.awscdk.services.synthetics.ArtifactsBucketLocation | cdk.support/lookup-entry | :artifacts-bucket-location |
canaryName | java.lang.String | cdk.support/lookup-entry | :canary-name |
cleanup | software.amazon.awscdk.services.synthetics.Cleanup | cdk.api.services.synthetics/cleanup | :cleanup |
environmentVariables | java.util.Map | cdk.support/lookup-entry | :environment-variables |
failureRetentionPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :failure-retention-period |
role | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :role |
runtime | software.amazon.awscdk.services.synthetics.Runtime | cdk.support/lookup-entry | :runtime |
schedule | software.amazon.awscdk.services.synthetics.Schedule | cdk.support/lookup-entry | :schedule |
securityGroups | java.util.List | cdk.support/lookup-entry | :security-groups |
startAfterCreation | java.lang.Boolean | cdk.support/lookup-entry | :start-after-creation |
successRetentionPeriod | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :success-retention-period |
test | software.amazon.awscdk.services.synthetics.Test | cdk.support/lookup-entry | :test |
timeToLive | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :time-to-live |
vpc | software.amazon.awscdk.services.ec2.IVpc | cdk.support/lookup-entry | :vpc |
vpcSubnets | software.amazon.awscdk.services.ec2.SubnetSelection | cdk.support/lookup-entry | :vpc-subnets |
The build-canary-props-builder function updates a CanaryProps$Builder instance using the provided configuration. The function takes the CanaryProps$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 | |---|---|---|---| | `artifactsBucketLifecycleRules` | java.util.List | [[cdk.support/lookup-entry]] | `:artifacts-bucket-lifecycle-rules` | | `artifactsBucketLocation` | software.amazon.awscdk.services.synthetics.ArtifactsBucketLocation | [[cdk.support/lookup-entry]] | `:artifacts-bucket-location` | | `canaryName` | java.lang.String | [[cdk.support/lookup-entry]] | `:canary-name` | | `cleanup` | software.amazon.awscdk.services.synthetics.Cleanup | [[cdk.api.services.synthetics/cleanup]] | `:cleanup` | | `environmentVariables` | java.util.Map | [[cdk.support/lookup-entry]] | `:environment-variables` | | `failureRetentionPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:failure-retention-period` | | `role` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:role` | | `runtime` | software.amazon.awscdk.services.synthetics.Runtime | [[cdk.support/lookup-entry]] | `:runtime` | | `schedule` | software.amazon.awscdk.services.synthetics.Schedule | [[cdk.support/lookup-entry]] | `:schedule` | | `securityGroups` | java.util.List | [[cdk.support/lookup-entry]] | `:security-groups` | | `startAfterCreation` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:start-after-creation` | | `successRetentionPeriod` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:success-retention-period` | | `test` | software.amazon.awscdk.services.synthetics.Test | [[cdk.support/lookup-entry]] | `:test` | | `timeToLive` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:time-to-live` | | `vpc` | software.amazon.awscdk.services.ec2.IVpc | [[cdk.support/lookup-entry]] | `:vpc` | | `vpcSubnets` | software.amazon.awscdk.services.ec2.SubnetSelection | [[cdk.support/lookup-entry]] | `:vpc-subnets` |
(build-cfn-canary-artifact-config-property-builder builder id config)
The build-cfn-canary-artifact-config-property-builder function updates a CfnCanary$ArtifactConfigProperty$Builder instance using the provided configuration. The function takes the CfnCanary$ArtifactConfigProperty$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 |
---|---|---|---|
s3Encryption | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :s3-encryption |
The build-cfn-canary-artifact-config-property-builder function updates a CfnCanary$ArtifactConfigProperty$Builder instance using the provided configuration. The function takes the CfnCanary$ArtifactConfigProperty$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 | |---|---|---|---| | `s3Encryption` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:s3-encryption` |
(build-cfn-canary-base-screenshot-property-builder builder id config)
The build-cfn-canary-base-screenshot-property-builder function updates a CfnCanary$BaseScreenshotProperty$Builder instance using the provided configuration. The function takes the CfnCanary$BaseScreenshotProperty$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 |
---|---|---|---|
ignoreCoordinates | java.util.List | cdk.support/lookup-entry | :ignore-coordinates |
screenshotName | java.lang.String | cdk.support/lookup-entry | :screenshot-name |
The build-cfn-canary-base-screenshot-property-builder function updates a CfnCanary$BaseScreenshotProperty$Builder instance using the provided configuration. The function takes the CfnCanary$BaseScreenshotProperty$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 | |---|---|---|---| | `ignoreCoordinates` | java.util.List | [[cdk.support/lookup-entry]] | `:ignore-coordinates` | | `screenshotName` | java.lang.String | [[cdk.support/lookup-entry]] | `:screenshot-name` |
(build-cfn-canary-builder builder id config)
The build-cfn-canary-builder function updates a CfnCanary$Builder instance using the provided configuration. The function takes the CfnCanary$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 |
---|---|---|---|
artifactConfig | software.amazon.awscdk.services.synthetics.CfnCanary$ArtifactConfigProperty | cdk.support/lookup-entry | :artifact-config |
artifactS3Location | java.lang.String | cdk.support/lookup-entry | :artifact-s3-location |
code | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :code |
deleteLambdaResourcesOnCanaryDeletion | java.lang.Boolean | cdk.support/lookup-entry | :delete-lambda-resources-on-canary-deletion |
executionRoleArn | java.lang.String | cdk.support/lookup-entry | :execution-role-arn |
failureRetentionPeriod | java.lang.Number | cdk.support/lookup-entry | :failure-retention-period |
name | java.lang.String | cdk.support/lookup-entry | :name |
runConfig | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :run-config |
runtimeVersion | java.lang.String | cdk.support/lookup-entry | :runtime-version |
schedule | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :schedule |
startCanaryAfterCreation | java.lang.Boolean | cdk.support/lookup-entry | :start-canary-after-creation |
successRetentionPeriod | java.lang.Number | cdk.support/lookup-entry | :success-retention-period |
tags | java.util.List | cdk.support/lookup-entry | :tags |
visualReference | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :visual-reference |
vpcConfig | software.amazon.awscdk.services.synthetics.CfnCanary$VPCConfigProperty | cdk.support/lookup-entry | :vpc-config |
The build-cfn-canary-builder function updates a CfnCanary$Builder instance using the provided configuration. The function takes the CfnCanary$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 | |---|---|---|---| | `artifactConfig` | software.amazon.awscdk.services.synthetics.CfnCanary$ArtifactConfigProperty | [[cdk.support/lookup-entry]] | `:artifact-config` | | `artifactS3Location` | java.lang.String | [[cdk.support/lookup-entry]] | `:artifact-s3-location` | | `code` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:code` | | `deleteLambdaResourcesOnCanaryDeletion` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:delete-lambda-resources-on-canary-deletion` | | `executionRoleArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:execution-role-arn` | | `failureRetentionPeriod` | java.lang.Number | [[cdk.support/lookup-entry]] | `:failure-retention-period` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `runConfig` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:run-config` | | `runtimeVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:runtime-version` | | `schedule` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:schedule` | | `startCanaryAfterCreation` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:start-canary-after-creation` | | `successRetentionPeriod` | java.lang.Number | [[cdk.support/lookup-entry]] | `:success-retention-period` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `visualReference` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:visual-reference` | | `vpcConfig` | software.amazon.awscdk.services.synthetics.CfnCanary$VPCConfigProperty | [[cdk.support/lookup-entry]] | `:vpc-config` |
(build-cfn-canary-code-property-builder builder id config)
The build-cfn-canary-code-property-builder function updates a CfnCanary$CodeProperty$Builder instance using the provided configuration. The function takes the CfnCanary$CodeProperty$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 |
---|---|---|---|
handler | java.lang.String | cdk.support/lookup-entry | :handler |
s3Bucket | java.lang.String | cdk.support/lookup-entry | :s3-bucket |
s3Key | java.lang.String | cdk.support/lookup-entry | :s3-key |
s3ObjectVersion | java.lang.String | cdk.support/lookup-entry | :s3-object-version |
script | java.lang.String | cdk.support/lookup-entry | :script |
sourceLocationArn | java.lang.String | cdk.support/lookup-entry | :source-location-arn |
The build-cfn-canary-code-property-builder function updates a CfnCanary$CodeProperty$Builder instance using the provided configuration. The function takes the CfnCanary$CodeProperty$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 | |---|---|---|---| | `handler` | java.lang.String | [[cdk.support/lookup-entry]] | `:handler` | | `s3Bucket` | java.lang.String | [[cdk.support/lookup-entry]] | `:s3-bucket` | | `s3Key` | java.lang.String | [[cdk.support/lookup-entry]] | `:s3-key` | | `s3ObjectVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:s3-object-version` | | `script` | java.lang.String | [[cdk.support/lookup-entry]] | `:script` | | `sourceLocationArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:source-location-arn` |
(build-cfn-canary-props-builder builder id config)
The build-cfn-canary-props-builder function updates a CfnCanaryProps$Builder instance using the provided configuration. The function takes the CfnCanaryProps$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 |
---|---|---|---|
artifactConfig | software.amazon.awscdk.services.synthetics.CfnCanary$ArtifactConfigProperty | cdk.support/lookup-entry | :artifact-config |
artifactS3Location | java.lang.String | cdk.support/lookup-entry | :artifact-s3-location |
code | software.amazon.awscdk.services.synthetics.CfnCanary$CodeProperty | cdk.support/lookup-entry | :code |
deleteLambdaResourcesOnCanaryDeletion | java.lang.Boolean | cdk.support/lookup-entry | :delete-lambda-resources-on-canary-deletion |
executionRoleArn | java.lang.String | cdk.support/lookup-entry | :execution-role-arn |
failureRetentionPeriod | java.lang.Number | cdk.support/lookup-entry | :failure-retention-period |
name | java.lang.String | cdk.support/lookup-entry | :name |
runConfig | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :run-config |
runtimeVersion | java.lang.String | cdk.support/lookup-entry | :runtime-version |
schedule | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :schedule |
startCanaryAfterCreation | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :start-canary-after-creation |
successRetentionPeriod | java.lang.Number | cdk.support/lookup-entry | :success-retention-period |
tags | java.util.List | cdk.support/lookup-entry | :tags |
visualReference | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :visual-reference |
vpcConfig | software.amazon.awscdk.services.synthetics.CfnCanary$VPCConfigProperty | cdk.support/lookup-entry | :vpc-config |
The build-cfn-canary-props-builder function updates a CfnCanaryProps$Builder instance using the provided configuration. The function takes the CfnCanaryProps$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 | |---|---|---|---| | `artifactConfig` | software.amazon.awscdk.services.synthetics.CfnCanary$ArtifactConfigProperty | [[cdk.support/lookup-entry]] | `:artifact-config` | | `artifactS3Location` | java.lang.String | [[cdk.support/lookup-entry]] | `:artifact-s3-location` | | `code` | software.amazon.awscdk.services.synthetics.CfnCanary$CodeProperty | [[cdk.support/lookup-entry]] | `:code` | | `deleteLambdaResourcesOnCanaryDeletion` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:delete-lambda-resources-on-canary-deletion` | | `executionRoleArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:execution-role-arn` | | `failureRetentionPeriod` | java.lang.Number | [[cdk.support/lookup-entry]] | `:failure-retention-period` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `runConfig` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:run-config` | | `runtimeVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:runtime-version` | | `schedule` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:schedule` | | `startCanaryAfterCreation` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:start-canary-after-creation` | | `successRetentionPeriod` | java.lang.Number | [[cdk.support/lookup-entry]] | `:success-retention-period` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `visualReference` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:visual-reference` | | `vpcConfig` | software.amazon.awscdk.services.synthetics.CfnCanary$VPCConfigProperty | [[cdk.support/lookup-entry]] | `:vpc-config` |
(build-cfn-canary-run-config-property-builder builder id config)
The build-cfn-canary-run-config-property-builder function updates a CfnCanary$RunConfigProperty$Builder instance using the provided configuration. The function takes the CfnCanary$RunConfigProperty$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 |
---|---|---|---|
activeTracing | java.lang.Boolean | cdk.support/lookup-entry | :active-tracing |
environmentVariables | java.util.Map | cdk.support/lookup-entry | :environment-variables |
memoryInMb | java.lang.Number | cdk.support/lookup-entry | :memory-in-mb |
timeoutInSeconds | java.lang.Number | cdk.support/lookup-entry | :timeout-in-seconds |
The build-cfn-canary-run-config-property-builder function updates a CfnCanary$RunConfigProperty$Builder instance using the provided configuration. The function takes the CfnCanary$RunConfigProperty$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 | |---|---|---|---| | `activeTracing` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:active-tracing` | | `environmentVariables` | java.util.Map | [[cdk.support/lookup-entry]] | `:environment-variables` | | `memoryInMb` | java.lang.Number | [[cdk.support/lookup-entry]] | `:memory-in-mb` | | `timeoutInSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:timeout-in-seconds` |
(build-cfn-canary-s3-encryption-property-builder builder id config)
The build-cfn-canary-s3-encryption-property-builder function updates a CfnCanary$S3EncryptionProperty$Builder instance using the provided configuration. The function takes the CfnCanary$S3EncryptionProperty$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 |
---|---|---|---|
encryptionMode | java.lang.String | cdk.support/lookup-entry | :encryption-mode |
kmsKeyArn | java.lang.String | cdk.support/lookup-entry | :kms-key-arn |
The build-cfn-canary-s3-encryption-property-builder function updates a CfnCanary$S3EncryptionProperty$Builder instance using the provided configuration. The function takes the CfnCanary$S3EncryptionProperty$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 | |---|---|---|---| | `encryptionMode` | java.lang.String | [[cdk.support/lookup-entry]] | `:encryption-mode` | | `kmsKeyArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:kms-key-arn` |
(build-cfn-canary-schedule-property-builder builder id config)
The build-cfn-canary-schedule-property-builder function updates a CfnCanary$ScheduleProperty$Builder instance using the provided configuration. The function takes the CfnCanary$ScheduleProperty$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 |
---|---|---|---|
durationInSeconds | java.lang.String | cdk.support/lookup-entry | :duration-in-seconds |
expression | java.lang.String | cdk.support/lookup-entry | :expression |
The build-cfn-canary-schedule-property-builder function updates a CfnCanary$ScheduleProperty$Builder instance using the provided configuration. The function takes the CfnCanary$ScheduleProperty$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 | |---|---|---|---| | `durationInSeconds` | java.lang.String | [[cdk.support/lookup-entry]] | `:duration-in-seconds` | | `expression` | java.lang.String | [[cdk.support/lookup-entry]] | `:expression` |
(build-cfn-canary-visual-reference-property-builder builder id config)
The build-cfn-canary-visual-reference-property-builder function updates a CfnCanary$VisualReferenceProperty$Builder instance using the provided configuration. The function takes the CfnCanary$VisualReferenceProperty$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 |
---|---|---|---|
baseCanaryRunId | java.lang.String | cdk.support/lookup-entry | :base-canary-run-id |
baseScreenshots | java.util.List | cdk.support/lookup-entry | :base-screenshots |
The build-cfn-canary-visual-reference-property-builder function updates a CfnCanary$VisualReferenceProperty$Builder instance using the provided configuration. The function takes the CfnCanary$VisualReferenceProperty$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 | |---|---|---|---| | `baseCanaryRunId` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-canary-run-id` | | `baseScreenshots` | java.util.List | [[cdk.support/lookup-entry]] | `:base-screenshots` |
(build-cfn-canary-vpc-config-property-builder builder id config)
The build-cfn-canary-vpc-config-property-builder function updates a CfnCanary$VPCConfigProperty$Builder instance using the provided configuration. The function takes the CfnCanary$VPCConfigProperty$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 |
---|---|---|---|
securityGroupIds | java.util.List | cdk.support/lookup-entry | :security-group-ids |
subnetIds | java.util.List | cdk.support/lookup-entry | :subnet-ids |
vpcId | java.lang.String | cdk.support/lookup-entry | :vpc-id |
The build-cfn-canary-vpc-config-property-builder function updates a CfnCanary$VPCConfigProperty$Builder instance using the provided configuration. The function takes the CfnCanary$VPCConfigProperty$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 | |---|---|---|---| | `securityGroupIds` | java.util.List | [[cdk.support/lookup-entry]] | `:security-group-ids` | | `subnetIds` | java.util.List | [[cdk.support/lookup-entry]] | `:subnet-ids` | | `vpcId` | java.lang.String | [[cdk.support/lookup-entry]] | `:vpc-id` |
(build-cfn-group-builder builder id config)
The build-cfn-group-builder function updates a CfnGroup$Builder instance using the provided configuration. The function takes the CfnGroup$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 |
resourceArns | java.util.List | cdk.support/lookup-entry | :resource-arns |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-group-builder function updates a CfnGroup$Builder instance using the provided configuration. The function takes the CfnGroup$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` | | `resourceArns` | java.util.List | [[cdk.support/lookup-entry]] | `:resource-arns` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-cfn-group-props-builder builder id config)
The build-cfn-group-props-builder function updates a CfnGroupProps$Builder instance using the provided configuration. The function takes the CfnGroupProps$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 |
resourceArns | java.util.List | cdk.support/lookup-entry | :resource-arns |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-group-props-builder function updates a CfnGroupProps$Builder instance using the provided configuration. The function takes the CfnGroupProps$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` | | `resourceArns` | java.util.List | [[cdk.support/lookup-entry]] | `:resource-arns` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-code-config-builder builder id config)
The build-code-config-builder function updates a CodeConfig$Builder instance using the provided configuration. The function takes the CodeConfig$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 |
---|---|---|---|
inlineCode | java.lang.String | cdk.support/lookup-entry | :inline-code |
s3Location | software.amazon.awscdk.services.s3.Location | cdk.support/lookup-entry | :s3-location |
The build-code-config-builder function updates a CodeConfig$Builder instance using the provided configuration. The function takes the CodeConfig$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 | |---|---|---|---| | `inlineCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:inline-code` | | `s3Location` | software.amazon.awscdk.services.s3.Location | [[cdk.support/lookup-entry]] | `:s3-location` |
(build-cron-options-builder builder id config)
The build-cron-options-builder function updates a CronOptions$Builder instance using the provided configuration. The function takes the CronOptions$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 |
---|---|---|---|
day | java.lang.String | cdk.support/lookup-entry | :day |
hour | java.lang.String | cdk.support/lookup-entry | :hour |
minute | java.lang.String | cdk.support/lookup-entry | :minute |
month | java.lang.String | cdk.support/lookup-entry | :month |
weekDay | java.lang.String | cdk.support/lookup-entry | :week-day |
The build-cron-options-builder function updates a CronOptions$Builder instance using the provided configuration. The function takes the CronOptions$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 | |---|---|---|---| | `day` | java.lang.String | [[cdk.support/lookup-entry]] | `:day` | | `hour` | java.lang.String | [[cdk.support/lookup-entry]] | `:hour` | | `minute` | java.lang.String | [[cdk.support/lookup-entry]] | `:minute` | | `month` | java.lang.String | [[cdk.support/lookup-entry]] | `:month` | | `weekDay` | java.lang.String | [[cdk.support/lookup-entry]] | `:week-day` |
(build-custom-test-options-builder builder id config)
The build-custom-test-options-builder function updates a CustomTestOptions$Builder instance using the provided configuration. The function takes the CustomTestOptions$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 |
---|---|---|---|
code | software.amazon.awscdk.services.synthetics.Code | cdk.support/lookup-entry | :code |
handler | java.lang.String | cdk.support/lookup-entry | :handler |
The build-custom-test-options-builder function updates a CustomTestOptions$Builder instance using the provided configuration. The function takes the CustomTestOptions$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 | |---|---|---|---| | `code` | software.amazon.awscdk.services.synthetics.Code | [[cdk.support/lookup-entry]] | `:code` | | `handler` | java.lang.String | [[cdk.support/lookup-entry]] | `:handler` |
(canary-builder scope id config)
Creates a Canary$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 `Canary$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 |
(canary-props-builder id config)
Creates a CanaryProps$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 `CanaryProps$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-canary-artifact-config-property-builder id config)
Creates a CfnCanary$ArtifactConfigProperty$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 `CfnCanary$ArtifactConfigProperty$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-canary-base-screenshot-property-builder id config)
Creates a CfnCanary$BaseScreenshotProperty$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 `CfnCanary$BaseScreenshotProperty$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-canary-builder scope id config)
Creates a CfnCanary$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 `CfnCanary$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-canary-code-property-builder id config)
Creates a CfnCanary$CodeProperty$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 `CfnCanary$CodeProperty$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-canary-props-builder id config)
Creates a CfnCanaryProps$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 `CfnCanaryProps$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-canary-run-config-property-builder id config)
Creates a CfnCanary$RunConfigProperty$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 `CfnCanary$RunConfigProperty$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-canary-s3-encryption-property-builder id config)
Creates a CfnCanary$S3EncryptionProperty$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 `CfnCanary$S3EncryptionProperty$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-canary-schedule-property-builder id config)
Creates a CfnCanary$ScheduleProperty$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 `CfnCanary$ScheduleProperty$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-canary-visual-reference-property-builder id config)
Creates a CfnCanary$VisualReferenceProperty$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 `CfnCanary$VisualReferenceProperty$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-canary-vpc-config-property-builder id config)
Creates a CfnCanary$VPCConfigProperty$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 `CfnCanary$VPCConfigProperty$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-group-builder scope id config)
Creates a CfnGroup$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 `CfnGroup$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-group-props-builder id config)
Creates a CfnGroupProps$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 `CfnGroupProps$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 |
(cleanup config id item-key)
The cleanup
function data interprets values in the provided config data into a
Cleanup
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:
Cleanup
- the value is returned.:nothing
- Cleanup/NOTHING
is returned:lambda
- Cleanup/LAMBDA
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `cleanup` function data interprets values in the provided config data into a `Cleanup` 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 `Cleanup` - the value is returned. * is `:nothing` - `Cleanup/NOTHING` is returned * is `:lambda` - `Cleanup/LAMBDA` is returned If a value is not found or matches the above criteria, nil is returned.
(code-config-builder id config)
Creates a CodeConfig$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 `CodeConfig$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 |
(cron-options-builder id config)
Creates a CronOptions$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 `CronOptions$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 |
(custom-test-options-builder id config)
Creates a CustomTestOptions$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 `CustomTestOptions$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 |
(runtime-family config id item-key)
The runtime-family
function data interprets values in the provided config data into a
RuntimeFamily
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:
RuntimeFamily
- the value is returned.:nodejs
- RuntimeFamily/NODEJS
is returned:python
- RuntimeFamily/PYTHON
is returned:other
- RuntimeFamily/OTHER
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `runtime-family` function data interprets values in the provided config data into a `RuntimeFamily` 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 `RuntimeFamily` - the value is returned. * is `:nodejs` - `RuntimeFamily/NODEJS` is returned * is `:python` - `RuntimeFamily/PYTHON` is returned * is `:other` - `RuntimeFamily/OTHER` 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