cdk.api.cloudformation.include
Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.cloudformation.include package.
Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.cloudformation.include package.
build-cfn-include-builderclj
(build-cfn-include-builder builder id config)The build-cfn-include-builder function updates a CfnInclude$Builder instance using the provided configuration. The function takes the CfnInclude$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 |
|---|---|---|---|
allowCyclicalReferences | java.lang.Boolean | cdk.support/lookup-entry | :allow-cyclical-references |
loadNestedStacks | java.util.Map | cdk.support/lookup-entry | :load-nested-stacks |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
preserveLogicalIds | java.lang.Boolean | cdk.support/lookup-entry | :preserve-logical-ids |
templateFile | java.lang.String | cdk.support/lookup-entry | :template-file |
The build-cfn-include-builder function updates a CfnInclude$Builder instance using the provided configuration. The function takes the CfnInclude$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 | |---|---|---|---| | `allowCyclicalReferences` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:allow-cyclical-references` | | `loadNestedStacks` | java.util.Map | [[cdk.support/lookup-entry]] | `:load-nested-stacks` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `preserveLogicalIds` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:preserve-logical-ids` | | `templateFile` | java.lang.String | [[cdk.support/lookup-entry]] | `:template-file` |
build-cfn-include-props-builderclj
(build-cfn-include-props-builder builder id config)The build-cfn-include-props-builder function updates a CfnIncludeProps$Builder instance using the provided configuration. The function takes the CfnIncludeProps$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 |
|---|---|---|---|
allowCyclicalReferences | java.lang.Boolean | cdk.support/lookup-entry | :allow-cyclical-references |
loadNestedStacks | java.util.Map | cdk.support/lookup-entry | :load-nested-stacks |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
preserveLogicalIds | java.lang.Boolean | cdk.support/lookup-entry | :preserve-logical-ids |
templateFile | java.lang.String | cdk.support/lookup-entry | :template-file |
The build-cfn-include-props-builder function updates a CfnIncludeProps$Builder instance using the provided configuration. The function takes the CfnIncludeProps$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 | |---|---|---|---| | `allowCyclicalReferences` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:allow-cyclical-references` | | `loadNestedStacks` | java.util.Map | [[cdk.support/lookup-entry]] | `:load-nested-stacks` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `preserveLogicalIds` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:preserve-logical-ids` | | `templateFile` | java.lang.String | [[cdk.support/lookup-entry]] | `:template-file` |
build-included-nested-stack-builderclj
(build-included-nested-stack-builder builder id config)The build-included-nested-stack-builder function updates a IncludedNestedStack$Builder instance using the provided configuration. The function takes the IncludedNestedStack$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 |
|---|---|---|---|
includedTemplate | software.amazon.awscdk.cloudformation.include.CfnInclude | cdk.support/lookup-entry | :included-template |
stack | software.amazon.awscdk.NestedStack | cdk.support/lookup-entry | :stack |
The build-included-nested-stack-builder function updates a IncludedNestedStack$Builder instance using the provided configuration. The function takes the IncludedNestedStack$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 | |---|---|---|---| | `includedTemplate` | software.amazon.awscdk.cloudformation.include.CfnInclude | [[cdk.support/lookup-entry]] | `:included-template` | | `stack` | software.amazon.awscdk.NestedStack | [[cdk.support/lookup-entry]] | `:stack` |
cfn-include-builderclj
(cfn-include-builder scope id config)Creates a CfnInclude$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 `CfnInclude$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-include-props-builderclj
(cfn-include-props-builder id config)Creates a CfnIncludeProps$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 `CfnIncludeProps$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 |
included-nested-stack-builderclj
(included-nested-stack-builder id config)Creates a IncludedNestedStack$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 `IncludedNestedStack$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