Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.apigateway package.
Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.apigateway package.
(access-log-destination-config-builder id config)
Creates a AccessLogDestinationConfig$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 `AccessLogDestinationConfig$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 |
(add-api-key-options-builder id config)
Creates a AddApiKeyOptions$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 `AddApiKeyOptions$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 |
(api-definition-config-builder id config)
Creates a ApiDefinitionConfig$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 `ApiDefinitionConfig$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 |
(api-definition-s3-location-builder id config)
Creates a ApiDefinitionS3Location$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 `ApiDefinitionS3Location$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 |
(api-key-builder scope id config)
Creates a ApiKey$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 `ApiKey$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 |
(api-key-options-builder id config)
Creates a ApiKeyOptions$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 `ApiKeyOptions$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 |
(api-key-props-builder id config)
Creates a ApiKeyProps$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 `ApiKeyProps$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 |
(api-key-source-type config id item-key)
The api-key-source-type
function data interprets values in the provided config data into a
ApiKeySourceType
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:
ApiKeySourceType
- the value is returned.:authorizer
- ApiKeySourceType/AUTHORIZER
is returned:header
- ApiKeySourceType/HEADER
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `api-key-source-type` function data interprets values in the provided config data into a `ApiKeySourceType` 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 `ApiKeySourceType` - the value is returned. * is `:authorizer` - `ApiKeySourceType/AUTHORIZER` is returned * is `:header` - `ApiKeySourceType/HEADER` is returned If a value is not found or matches the above criteria, nil is returned.
(api-mapping-options-builder id config)
Creates a ApiMappingOptions$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 `ApiMappingOptions$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-api-definition-builder path id config)
Creates a AssetApiDefinition$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 `AssetApiDefinition$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 |
(authorization-type config id item-key)
The authorization-type
function data interprets values in the provided config data into a
AuthorizationType
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:
AuthorizationType
- the value is returned.:none
- AuthorizationType/NONE
is returned:iam
- AuthorizationType/IAM
is returned:cognito
- AuthorizationType/COGNITO
is returned:custom
- AuthorizationType/CUSTOM
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `authorization-type` function data interprets values in the provided config data into a `AuthorizationType` 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 `AuthorizationType` - the value is returned. * is `:none` - `AuthorizationType/NONE` is returned * is `:iam` - `AuthorizationType/IAM` is returned * is `:cognito` - `AuthorizationType/COGNITO` is returned * is `:custom` - `AuthorizationType/CUSTOM` is returned If a value is not found or matches the above criteria, nil is returned.
(aws-integration-builder id config)
Creates a AwsIntegration$Builder
instance using a no-argument create, 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 `AwsIntegration$Builder` instance using a no-argument create, 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 |
(aws-integration-props-builder id config)
Creates a AwsIntegrationProps$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 `AwsIntegrationProps$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 |
(base-path-mapping-builder scope id config)
Creates a BasePathMapping$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 `BasePathMapping$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 |
(base-path-mapping-options-builder id config)
Creates a BasePathMappingOptions$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 `BasePathMappingOptions$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 |
(base-path-mapping-props-builder id config)
Creates a BasePathMappingProps$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 `BasePathMappingProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(build-access-log-destination-config-builder builder id config)
The build-access-log-destination-config-builder function updates a AccessLogDestinationConfig$Builder instance using the provided configuration. The function takes the AccessLogDestinationConfig$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 |
---|---|---|---|
destinationArn | java.lang.String | cdk.support/lookup-entry | :destination-arn |
The build-access-log-destination-config-builder function updates a AccessLogDestinationConfig$Builder instance using the provided configuration. The function takes the AccessLogDestinationConfig$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 | |---|---|---|---| | `destinationArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:destination-arn` |
(build-add-api-key-options-builder builder id config)
The build-add-api-key-options-builder function updates a AddApiKeyOptions$Builder instance using the provided configuration. The function takes the AddApiKeyOptions$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 |
---|---|---|---|
overrideLogicalId | java.lang.String | cdk.support/lookup-entry | :override-logical-id |
The build-add-api-key-options-builder function updates a AddApiKeyOptions$Builder instance using the provided configuration. The function takes the AddApiKeyOptions$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 | |---|---|---|---| | `overrideLogicalId` | java.lang.String | [[cdk.support/lookup-entry]] | `:override-logical-id` |
(build-api-definition-config-builder builder id config)
The build-api-definition-config-builder function updates a ApiDefinitionConfig$Builder instance using the provided configuration. The function takes the ApiDefinitionConfig$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 |
---|---|---|---|
inlineDefinition | java.lang.Object | cdk.support/lookup-entry | :inline-definition |
s3Location | software.amazon.awscdk.services.apigateway.ApiDefinitionS3Location | cdk.support/lookup-entry | :s3-location |
The build-api-definition-config-builder function updates a ApiDefinitionConfig$Builder instance using the provided configuration. The function takes the ApiDefinitionConfig$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 | |---|---|---|---| | `inlineDefinition` | java.lang.Object | [[cdk.support/lookup-entry]] | `:inline-definition` | | `s3Location` | software.amazon.awscdk.services.apigateway.ApiDefinitionS3Location | [[cdk.support/lookup-entry]] | `:s3-location` |
(build-api-definition-s3-location-builder builder id config)
The build-api-definition-s3-location-builder function updates a ApiDefinitionS3Location$Builder instance using the provided configuration. The function takes the ApiDefinitionS3Location$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 | java.lang.String | cdk.support/lookup-entry | :bucket |
key | java.lang.String | cdk.support/lookup-entry | :key |
version | java.lang.String | cdk.support/lookup-entry | :version |
The build-api-definition-s3-location-builder function updates a ApiDefinitionS3Location$Builder instance using the provided configuration. The function takes the ApiDefinitionS3Location$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` | java.lang.String | [[cdk.support/lookup-entry]] | `:bucket` | | `key` | java.lang.String | [[cdk.support/lookup-entry]] | `:key` | | `version` | java.lang.String | [[cdk.support/lookup-entry]] | `:version` |
(build-api-key-builder builder id config)
The build-api-key-builder function updates a ApiKey$Builder instance using the provided configuration. The function takes the ApiKey$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 |
---|---|---|---|
apiKeyName | java.lang.String | cdk.support/lookup-entry | :api-key-name |
customerId | java.lang.String | cdk.support/lookup-entry | :customer-id |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
generateDistinctId | java.lang.Boolean | cdk.support/lookup-entry | :generate-distinct-id |
resources | java.util.List | cdk.support/lookup-entry | :resources |
stages | java.util.List | cdk.support/lookup-entry | :stages |
value | java.lang.String | cdk.support/lookup-entry | :value |
The build-api-key-builder function updates a ApiKey$Builder instance using the provided configuration. The function takes the ApiKey$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 | |---|---|---|---| | `apiKeyName` | java.lang.String | [[cdk.support/lookup-entry]] | `:api-key-name` | | `customerId` | java.lang.String | [[cdk.support/lookup-entry]] | `:customer-id` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `generateDistinctId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:generate-distinct-id` | | `resources` | java.util.List | [[cdk.support/lookup-entry]] | `:resources` | | `stages` | java.util.List | [[cdk.support/lookup-entry]] | `:stages` | | `value` | java.lang.String | [[cdk.support/lookup-entry]] | `:value` |
(build-api-key-options-builder builder id config)
The build-api-key-options-builder function updates a ApiKeyOptions$Builder instance using the provided configuration. The function takes the ApiKeyOptions$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 |
---|---|---|---|
apiKeyName | java.lang.String | cdk.support/lookup-entry | :api-key-name |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
value | java.lang.String | cdk.support/lookup-entry | :value |
The build-api-key-options-builder function updates a ApiKeyOptions$Builder instance using the provided configuration. The function takes the ApiKeyOptions$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 | |---|---|---|---| | `apiKeyName` | java.lang.String | [[cdk.support/lookup-entry]] | `:api-key-name` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `value` | java.lang.String | [[cdk.support/lookup-entry]] | `:value` |
(build-api-key-props-builder builder id config)
The build-api-key-props-builder function updates a ApiKeyProps$Builder instance using the provided configuration. The function takes the ApiKeyProps$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 |
---|---|---|---|
apiKeyName | java.lang.String | cdk.support/lookup-entry | :api-key-name |
customerId | java.lang.String | cdk.support/lookup-entry | :customer-id |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
generateDistinctId | java.lang.Boolean | cdk.support/lookup-entry | :generate-distinct-id |
resources | java.util.List | cdk.support/lookup-entry | :resources |
stages | java.util.List | cdk.support/lookup-entry | :stages |
value | java.lang.String | cdk.support/lookup-entry | :value |
The build-api-key-props-builder function updates a ApiKeyProps$Builder instance using the provided configuration. The function takes the ApiKeyProps$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 | |---|---|---|---| | `apiKeyName` | java.lang.String | [[cdk.support/lookup-entry]] | `:api-key-name` | | `customerId` | java.lang.String | [[cdk.support/lookup-entry]] | `:customer-id` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `generateDistinctId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:generate-distinct-id` | | `resources` | java.util.List | [[cdk.support/lookup-entry]] | `:resources` | | `stages` | java.util.List | [[cdk.support/lookup-entry]] | `:stages` | | `value` | java.lang.String | [[cdk.support/lookup-entry]] | `:value` |
(build-api-mapping-options-builder builder id config)
The build-api-mapping-options-builder function updates a ApiMappingOptions$Builder instance using the provided configuration. The function takes the ApiMappingOptions$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 |
---|---|---|---|
basePath | java.lang.String | cdk.support/lookup-entry | :base-path |
The build-api-mapping-options-builder function updates a ApiMappingOptions$Builder instance using the provided configuration. The function takes the ApiMappingOptions$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 | |---|---|---|---| | `basePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-path` |
(build-asset-api-definition-builder builder id config)
The build-asset-api-definition-builder function updates a AssetApiDefinition$Builder instance using the provided configuration. The function takes the AssetApiDefinition$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-api-definition-builder function updates a AssetApiDefinition$Builder instance using the provided configuration. The function takes the AssetApiDefinition$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-aws-integration-builder builder id config)
The build-aws-integration-builder function updates a AwsIntegration$Builder instance using the provided configuration. The function takes the AwsIntegration$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 |
---|---|---|---|
action | java.lang.String | cdk.support/lookup-entry | :action |
actionParameters | java.util.Map | cdk.support/lookup-entry | :action-parameters |
integrationHttpMethod | java.lang.String | cdk.support/lookup-entry | :integration-http-method |
options | software.amazon.awscdk.services.apigateway.IntegrationOptions | cdk.support/lookup-entry | :options |
path | java.lang.String | cdk.support/lookup-entry | :path |
proxy | java.lang.Boolean | cdk.support/lookup-entry | :proxy |
region | java.lang.String | cdk.support/lookup-entry | :region |
service | java.lang.String | cdk.support/lookup-entry | :service |
subdomain | java.lang.String | cdk.support/lookup-entry | :subdomain |
The build-aws-integration-builder function updates a AwsIntegration$Builder instance using the provided configuration. The function takes the AwsIntegration$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 | |---|---|---|---| | `action` | java.lang.String | [[cdk.support/lookup-entry]] | `:action` | | `actionParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:action-parameters` | | `integrationHttpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:integration-http-method` | | `options` | software.amazon.awscdk.services.apigateway.IntegrationOptions | [[cdk.support/lookup-entry]] | `:options` | | `path` | java.lang.String | [[cdk.support/lookup-entry]] | `:path` | | `proxy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:proxy` | | `region` | java.lang.String | [[cdk.support/lookup-entry]] | `:region` | | `service` | java.lang.String | [[cdk.support/lookup-entry]] | `:service` | | `subdomain` | java.lang.String | [[cdk.support/lookup-entry]] | `:subdomain` |
(build-aws-integration-props-builder builder id config)
The build-aws-integration-props-builder function updates a AwsIntegrationProps$Builder instance using the provided configuration. The function takes the AwsIntegrationProps$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 |
---|---|---|---|
action | java.lang.String | cdk.support/lookup-entry | :action |
actionParameters | java.util.Map | cdk.support/lookup-entry | :action-parameters |
integrationHttpMethod | java.lang.String | cdk.support/lookup-entry | :integration-http-method |
options | software.amazon.awscdk.services.apigateway.IntegrationOptions | cdk.support/lookup-entry | :options |
path | java.lang.String | cdk.support/lookup-entry | :path |
proxy | java.lang.Boolean | cdk.support/lookup-entry | :proxy |
region | java.lang.String | cdk.support/lookup-entry | :region |
service | java.lang.String | cdk.support/lookup-entry | :service |
subdomain | java.lang.String | cdk.support/lookup-entry | :subdomain |
The build-aws-integration-props-builder function updates a AwsIntegrationProps$Builder instance using the provided configuration. The function takes the AwsIntegrationProps$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 | |---|---|---|---| | `action` | java.lang.String | [[cdk.support/lookup-entry]] | `:action` | | `actionParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:action-parameters` | | `integrationHttpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:integration-http-method` | | `options` | software.amazon.awscdk.services.apigateway.IntegrationOptions | [[cdk.support/lookup-entry]] | `:options` | | `path` | java.lang.String | [[cdk.support/lookup-entry]] | `:path` | | `proxy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:proxy` | | `region` | java.lang.String | [[cdk.support/lookup-entry]] | `:region` | | `service` | java.lang.String | [[cdk.support/lookup-entry]] | `:service` | | `subdomain` | java.lang.String | [[cdk.support/lookup-entry]] | `:subdomain` |
(build-base-path-mapping-builder builder id config)
The build-base-path-mapping-builder function updates a BasePathMapping$Builder instance using the provided configuration. The function takes the BasePathMapping$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 |
---|---|---|---|
attachToStage | java.lang.Boolean | cdk.support/lookup-entry | :attach-to-stage |
basePath | java.lang.String | cdk.support/lookup-entry | :base-path |
domainName | software.amazon.awscdk.services.apigateway.IDomainName | cdk.support/lookup-entry | :domain-name |
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
stage | software.amazon.awscdk.services.apigateway.Stage | cdk.support/lookup-entry | :stage |
The build-base-path-mapping-builder function updates a BasePathMapping$Builder instance using the provided configuration. The function takes the BasePathMapping$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 | |---|---|---|---| | `attachToStage` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:attach-to-stage` | | `basePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-path` | | `domainName` | software.amazon.awscdk.services.apigateway.IDomainName | [[cdk.support/lookup-entry]] | `:domain-name` | | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` | | `stage` | software.amazon.awscdk.services.apigateway.Stage | [[cdk.support/lookup-entry]] | `:stage` |
(build-base-path-mapping-options-builder builder id config)
The build-base-path-mapping-options-builder function updates a BasePathMappingOptions$Builder instance using the provided configuration. The function takes the BasePathMappingOptions$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 |
---|---|---|---|
attachToStage | java.lang.Boolean | cdk.support/lookup-entry | :attach-to-stage |
basePath | java.lang.String | cdk.support/lookup-entry | :base-path |
stage | software.amazon.awscdk.services.apigateway.Stage | cdk.support/lookup-entry | :stage |
The build-base-path-mapping-options-builder function updates a BasePathMappingOptions$Builder instance using the provided configuration. The function takes the BasePathMappingOptions$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 | |---|---|---|---| | `attachToStage` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:attach-to-stage` | | `basePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-path` | | `stage` | software.amazon.awscdk.services.apigateway.Stage | [[cdk.support/lookup-entry]] | `:stage` |
(build-base-path-mapping-props-builder builder id config)
The build-base-path-mapping-props-builder function updates a BasePathMappingProps$Builder instance using the provided configuration. The function takes the BasePathMappingProps$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 |
---|---|---|---|
attachToStage | java.lang.Boolean | cdk.support/lookup-entry | :attach-to-stage |
basePath | java.lang.String | cdk.support/lookup-entry | :base-path |
domainName | software.amazon.awscdk.services.apigateway.IDomainName | cdk.support/lookup-entry | :domain-name |
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
stage | software.amazon.awscdk.services.apigateway.Stage | cdk.support/lookup-entry | :stage |
The build-base-path-mapping-props-builder function updates a BasePathMappingProps$Builder instance using the provided configuration. The function takes the BasePathMappingProps$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 | |---|---|---|---| | `attachToStage` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:attach-to-stage` | | `basePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-path` | | `domainName` | software.amazon.awscdk.services.apigateway.IDomainName | [[cdk.support/lookup-entry]] | `:domain-name` | | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` | | `stage` | software.amazon.awscdk.services.apigateway.Stage | [[cdk.support/lookup-entry]] | `:stage` |
(build-cfn-account-builder builder id config)
The build-cfn-account-builder function updates a CfnAccount$Builder instance using the provided configuration. The function takes the CfnAccount$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 |
---|---|---|---|
cloudWatchRoleArn | java.lang.String | cdk.support/lookup-entry | :cloud-watch-role-arn |
The build-cfn-account-builder function updates a CfnAccount$Builder instance using the provided configuration. The function takes the CfnAccount$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 | |---|---|---|---| | `cloudWatchRoleArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:cloud-watch-role-arn` |
(build-cfn-account-props-builder builder id config)
The build-cfn-account-props-builder function updates a CfnAccountProps$Builder instance using the provided configuration. The function takes the CfnAccountProps$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 |
---|---|---|---|
cloudWatchRoleArn | java.lang.String | cdk.support/lookup-entry | :cloud-watch-role-arn |
The build-cfn-account-props-builder function updates a CfnAccountProps$Builder instance using the provided configuration. The function takes the CfnAccountProps$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 | |---|---|---|---| | `cloudWatchRoleArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:cloud-watch-role-arn` |
(build-cfn-api-key-builder builder id config)
The build-cfn-api-key-builder function updates a CfnApiKey$Builder instance using the provided configuration. The function takes the CfnApiKey$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 |
---|---|---|---|
customerId | java.lang.String | cdk.support/lookup-entry | :customer-id |
description | java.lang.String | cdk.support/lookup-entry | :description |
enabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :enabled |
generateDistinctId | java.lang.Boolean | cdk.support/lookup-entry | :generate-distinct-id |
name | java.lang.String | cdk.support/lookup-entry | :name |
stageKeys | java.util.List | cdk.support/lookup-entry | :stage-keys |
tags | java.util.List | cdk.support/lookup-entry | :tags |
value | java.lang.String | cdk.support/lookup-entry | :value |
The build-cfn-api-key-builder function updates a CfnApiKey$Builder instance using the provided configuration. The function takes the CfnApiKey$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 | |---|---|---|---| | `customerId` | java.lang.String | [[cdk.support/lookup-entry]] | `:customer-id` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:enabled` | | `generateDistinctId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:generate-distinct-id` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `stageKeys` | java.util.List | [[cdk.support/lookup-entry]] | `:stage-keys` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `value` | java.lang.String | [[cdk.support/lookup-entry]] | `:value` |
(build-cfn-api-key-props-builder builder id config)
The build-cfn-api-key-props-builder function updates a CfnApiKeyProps$Builder instance using the provided configuration. The function takes the CfnApiKeyProps$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 |
---|---|---|---|
customerId | java.lang.String | cdk.support/lookup-entry | :customer-id |
description | java.lang.String | cdk.support/lookup-entry | :description |
enabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :enabled |
generateDistinctId | java.lang.Boolean | cdk.support/lookup-entry | :generate-distinct-id |
name | java.lang.String | cdk.support/lookup-entry | :name |
stageKeys | java.util.List | cdk.support/lookup-entry | :stage-keys |
tags | java.util.List | cdk.support/lookup-entry | :tags |
value | java.lang.String | cdk.support/lookup-entry | :value |
The build-cfn-api-key-props-builder function updates a CfnApiKeyProps$Builder instance using the provided configuration. The function takes the CfnApiKeyProps$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 | |---|---|---|---| | `customerId` | java.lang.String | [[cdk.support/lookup-entry]] | `:customer-id` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:enabled` | | `generateDistinctId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:generate-distinct-id` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `stageKeys` | java.util.List | [[cdk.support/lookup-entry]] | `:stage-keys` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `value` | java.lang.String | [[cdk.support/lookup-entry]] | `:value` |
(build-cfn-api-key-stage-key-property-builder builder id config)
The build-cfn-api-key-stage-key-property-builder function updates a CfnApiKey$StageKeyProperty$Builder instance using the provided configuration. The function takes the CfnApiKey$StageKeyProperty$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 |
---|---|---|---|
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
The build-cfn-api-key-stage-key-property-builder function updates a CfnApiKey$StageKeyProperty$Builder instance using the provided configuration. The function takes the CfnApiKey$StageKeyProperty$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 | |---|---|---|---| | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` |
(build-cfn-authorizer-builder builder id config)
The build-cfn-authorizer-builder function updates a CfnAuthorizer$Builder instance using the provided configuration. The function takes the CfnAuthorizer$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 |
---|---|---|---|
authType | java.lang.String | cdk.support/lookup-entry | :auth-type |
authorizerCredentials | java.lang.String | cdk.support/lookup-entry | :authorizer-credentials |
authorizerResultTtlInSeconds | java.lang.Number | cdk.support/lookup-entry | :authorizer-result-ttl-in-seconds |
authorizerUri | java.lang.String | cdk.support/lookup-entry | :authorizer-uri |
identitySource | java.lang.String | cdk.support/lookup-entry | :identity-source |
identityValidationExpression | java.lang.String | cdk.support/lookup-entry | :identity-validation-expression |
name | java.lang.String | cdk.support/lookup-entry | :name |
providerArns | java.util.List | cdk.support/lookup-entry | :provider-arns |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
type | java.lang.String | cdk.support/lookup-entry | :type |
The build-cfn-authorizer-builder function updates a CfnAuthorizer$Builder instance using the provided configuration. The function takes the CfnAuthorizer$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 | |---|---|---|---| | `authType` | java.lang.String | [[cdk.support/lookup-entry]] | `:auth-type` | | `authorizerCredentials` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-credentials` | | `authorizerResultTtlInSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:authorizer-result-ttl-in-seconds` | | `authorizerUri` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-uri` | | `identitySource` | java.lang.String | [[cdk.support/lookup-entry]] | `:identity-source` | | `identityValidationExpression` | java.lang.String | [[cdk.support/lookup-entry]] | `:identity-validation-expression` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `providerArns` | java.util.List | [[cdk.support/lookup-entry]] | `:provider-arns` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `type` | java.lang.String | [[cdk.support/lookup-entry]] | `:type` |
(build-cfn-authorizer-props-builder builder id config)
The build-cfn-authorizer-props-builder function updates a CfnAuthorizerProps$Builder instance using the provided configuration. The function takes the CfnAuthorizerProps$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 |
---|---|---|---|
authType | java.lang.String | cdk.support/lookup-entry | :auth-type |
authorizerCredentials | java.lang.String | cdk.support/lookup-entry | :authorizer-credentials |
authorizerResultTtlInSeconds | java.lang.Number | cdk.support/lookup-entry | :authorizer-result-ttl-in-seconds |
authorizerUri | java.lang.String | cdk.support/lookup-entry | :authorizer-uri |
identitySource | java.lang.String | cdk.support/lookup-entry | :identity-source |
identityValidationExpression | java.lang.String | cdk.support/lookup-entry | :identity-validation-expression |
name | java.lang.String | cdk.support/lookup-entry | :name |
providerArns | java.util.List | cdk.support/lookup-entry | :provider-arns |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
type | java.lang.String | cdk.support/lookup-entry | :type |
The build-cfn-authorizer-props-builder function updates a CfnAuthorizerProps$Builder instance using the provided configuration. The function takes the CfnAuthorizerProps$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 | |---|---|---|---| | `authType` | java.lang.String | [[cdk.support/lookup-entry]] | `:auth-type` | | `authorizerCredentials` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-credentials` | | `authorizerResultTtlInSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:authorizer-result-ttl-in-seconds` | | `authorizerUri` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-uri` | | `identitySource` | java.lang.String | [[cdk.support/lookup-entry]] | `:identity-source` | | `identityValidationExpression` | java.lang.String | [[cdk.support/lookup-entry]] | `:identity-validation-expression` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `providerArns` | java.util.List | [[cdk.support/lookup-entry]] | `:provider-arns` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `type` | java.lang.String | [[cdk.support/lookup-entry]] | `:type` |
(build-cfn-base-path-mapping-builder builder id config)
The build-cfn-base-path-mapping-builder function updates a CfnBasePathMapping$Builder instance using the provided configuration. The function takes the CfnBasePathMapping$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 |
---|---|---|---|
basePath | java.lang.String | cdk.support/lookup-entry | :base-path |
domainName | java.lang.String | cdk.support/lookup-entry | :domain-name |
id | java.lang.String | cdk.support/lookup-entry | :id |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
stage | java.lang.String | cdk.support/lookup-entry | :stage |
The build-cfn-base-path-mapping-builder function updates a CfnBasePathMapping$Builder instance using the provided configuration. The function takes the CfnBasePathMapping$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 | |---|---|---|---| | `basePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-path` | | `domainName` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name` | | `id` | java.lang.String | [[cdk.support/lookup-entry]] | `:id` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `stage` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage` |
(build-cfn-base-path-mapping-props-builder builder id config)
The build-cfn-base-path-mapping-props-builder function updates a CfnBasePathMappingProps$Builder instance using the provided configuration. The function takes the CfnBasePathMappingProps$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 |
---|---|---|---|
basePath | java.lang.String | cdk.support/lookup-entry | :base-path |
domainName | java.lang.String | cdk.support/lookup-entry | :domain-name |
id | java.lang.String | cdk.support/lookup-entry | :id |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
stage | java.lang.String | cdk.support/lookup-entry | :stage |
The build-cfn-base-path-mapping-props-builder function updates a CfnBasePathMappingProps$Builder instance using the provided configuration. The function takes the CfnBasePathMappingProps$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 | |---|---|---|---| | `basePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-path` | | `domainName` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name` | | `id` | java.lang.String | [[cdk.support/lookup-entry]] | `:id` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `stage` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage` |
(build-cfn-client-certificate-builder builder id config)
The build-cfn-client-certificate-builder function updates a CfnClientCertificate$Builder instance using the provided configuration. The function takes the CfnClientCertificate$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-client-certificate-builder function updates a CfnClientCertificate$Builder instance using the provided configuration. The function takes the CfnClientCertificate$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-cfn-client-certificate-props-builder builder id config)
The build-cfn-client-certificate-props-builder function updates a CfnClientCertificateProps$Builder instance using the provided configuration. The function takes the CfnClientCertificateProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-client-certificate-props-builder function updates a CfnClientCertificateProps$Builder instance using the provided configuration. The function takes the CfnClientCertificateProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-cfn-deployment-access-log-setting-property-builder builder id config)
The build-cfn-deployment-access-log-setting-property-builder function updates a CfnDeployment$AccessLogSettingProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$AccessLogSettingProperty$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 |
---|---|---|---|
destinationArn | java.lang.String | cdk.support/lookup-entry | :destination-arn |
format | java.lang.String | cdk.support/lookup-entry | :format |
The build-cfn-deployment-access-log-setting-property-builder function updates a CfnDeployment$AccessLogSettingProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$AccessLogSettingProperty$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 | |---|---|---|---| | `destinationArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:destination-arn` | | `format` | java.lang.String | [[cdk.support/lookup-entry]] | `:format` |
(build-cfn-deployment-builder builder id config)
The build-cfn-deployment-builder function updates a CfnDeployment$Builder instance using the provided configuration. The function takes the CfnDeployment$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 |
---|---|---|---|
deploymentCanarySettings | software.amazon.awscdk.services.apigateway.CfnDeployment$DeploymentCanarySettingsProperty | cdk.support/lookup-entry | :deployment-canary-settings |
description | java.lang.String | cdk.support/lookup-entry | :description |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
stageDescription | software.amazon.awscdk.services.apigateway.CfnDeployment$StageDescriptionProperty | cdk.support/lookup-entry | :stage-description |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
The build-cfn-deployment-builder function updates a CfnDeployment$Builder instance using the provided configuration. The function takes the CfnDeployment$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 | |---|---|---|---| | `deploymentCanarySettings` | software.amazon.awscdk.services.apigateway.CfnDeployment$DeploymentCanarySettingsProperty | [[cdk.support/lookup-entry]] | `:deployment-canary-settings` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `stageDescription` | software.amazon.awscdk.services.apigateway.CfnDeployment$StageDescriptionProperty | [[cdk.support/lookup-entry]] | `:stage-description` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` |
(build-cfn-deployment-canary-setting-property-builder builder id config)
The build-cfn-deployment-canary-setting-property-builder function updates a CfnDeployment$CanarySettingProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$CanarySettingProperty$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 |
---|---|---|---|
percentTraffic | java.lang.Number | cdk.support/lookup-entry | :percent-traffic |
stageVariableOverrides | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :stage-variable-overrides |
useStageCache | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :use-stage-cache |
The build-cfn-deployment-canary-setting-property-builder function updates a CfnDeployment$CanarySettingProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$CanarySettingProperty$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 | |---|---|---|---| | `percentTraffic` | java.lang.Number | [[cdk.support/lookup-entry]] | `:percent-traffic` | | `stageVariableOverrides` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:stage-variable-overrides` | | `useStageCache` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:use-stage-cache` |
(build-cfn-deployment-deployment-canary-settings-property-builder builder
id
config)
The build-cfn-deployment-deployment-canary-settings-property-builder function updates a CfnDeployment$DeploymentCanarySettingsProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$DeploymentCanarySettingsProperty$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 |
---|---|---|---|
percentTraffic | java.lang.Number | cdk.support/lookup-entry | :percent-traffic |
stageVariableOverrides | java.util.Map | cdk.support/lookup-entry | :stage-variable-overrides |
useStageCache | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :use-stage-cache |
The build-cfn-deployment-deployment-canary-settings-property-builder function updates a CfnDeployment$DeploymentCanarySettingsProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$DeploymentCanarySettingsProperty$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 | |---|---|---|---| | `percentTraffic` | java.lang.Number | [[cdk.support/lookup-entry]] | `:percent-traffic` | | `stageVariableOverrides` | java.util.Map | [[cdk.support/lookup-entry]] | `:stage-variable-overrides` | | `useStageCache` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:use-stage-cache` |
(build-cfn-deployment-method-setting-property-builder builder id config)
The build-cfn-deployment-method-setting-property-builder function updates a CfnDeployment$MethodSettingProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$MethodSettingProperty$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 |
---|---|---|---|
cacheDataEncrypted | java.lang.Boolean | cdk.support/lookup-entry | :cache-data-encrypted |
cacheTtlInSeconds | java.lang.Number | cdk.support/lookup-entry | :cache-ttl-in-seconds |
cachingEnabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :caching-enabled |
dataTraceEnabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :data-trace-enabled |
httpMethod | java.lang.String | cdk.support/lookup-entry | :http-method |
loggingLevel | java.lang.String | cdk.support/lookup-entry | :logging-level |
metricsEnabled | java.lang.Boolean | cdk.support/lookup-entry | :metrics-enabled |
resourcePath | java.lang.String | cdk.support/lookup-entry | :resource-path |
throttlingBurstLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-burst-limit |
throttlingRateLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-rate-limit |
The build-cfn-deployment-method-setting-property-builder function updates a CfnDeployment$MethodSettingProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$MethodSettingProperty$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 | |---|---|---|---| | `cacheDataEncrypted` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-data-encrypted` | | `cacheTtlInSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:cache-ttl-in-seconds` | | `cachingEnabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:caching-enabled` | | `dataTraceEnabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:data-trace-enabled` | | `httpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:http-method` | | `loggingLevel` | java.lang.String | [[cdk.support/lookup-entry]] | `:logging-level` | | `metricsEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:metrics-enabled` | | `resourcePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:resource-path` | | `throttlingBurstLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-burst-limit` | | `throttlingRateLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-rate-limit` |
(build-cfn-deployment-props-builder builder id config)
The build-cfn-deployment-props-builder function updates a CfnDeploymentProps$Builder instance using the provided configuration. The function takes the CfnDeploymentProps$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 |
---|---|---|---|
deploymentCanarySettings | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :deployment-canary-settings |
description | java.lang.String | cdk.support/lookup-entry | :description |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
stageDescription | software.amazon.awscdk.services.apigateway.CfnDeployment$StageDescriptionProperty | cdk.support/lookup-entry | :stage-description |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
The build-cfn-deployment-props-builder function updates a CfnDeploymentProps$Builder instance using the provided configuration. The function takes the CfnDeploymentProps$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 | |---|---|---|---| | `deploymentCanarySettings` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:deployment-canary-settings` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `stageDescription` | software.amazon.awscdk.services.apigateway.CfnDeployment$StageDescriptionProperty | [[cdk.support/lookup-entry]] | `:stage-description` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` |
(build-cfn-deployment-stage-description-property-builder builder id config)
The build-cfn-deployment-stage-description-property-builder function updates a CfnDeployment$StageDescriptionProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$StageDescriptionProperty$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 |
---|---|---|---|
accessLogSetting | software.amazon.awscdk.services.apigateway.CfnDeployment$AccessLogSettingProperty | cdk.support/lookup-entry | :access-log-setting |
cacheClusterEnabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :cache-cluster-enabled |
cacheClusterSize | java.lang.String | cdk.support/lookup-entry | :cache-cluster-size |
cacheDataEncrypted | java.lang.Boolean | cdk.support/lookup-entry | :cache-data-encrypted |
cacheTtlInSeconds | java.lang.Number | cdk.support/lookup-entry | :cache-ttl-in-seconds |
cachingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :caching-enabled |
canarySetting | software.amazon.awscdk.services.apigateway.CfnDeployment$CanarySettingProperty | cdk.support/lookup-entry | :canary-setting |
clientCertificateId | java.lang.String | cdk.support/lookup-entry | :client-certificate-id |
dataTraceEnabled | java.lang.Boolean | cdk.support/lookup-entry | :data-trace-enabled |
description | java.lang.String | cdk.support/lookup-entry | :description |
documentationVersion | java.lang.String | cdk.support/lookup-entry | :documentation-version |
loggingLevel | java.lang.String | cdk.support/lookup-entry | :logging-level |
methodSettings | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :method-settings |
metricsEnabled | java.lang.Boolean | cdk.support/lookup-entry | :metrics-enabled |
tags | java.util.List | cdk.support/lookup-entry | :tags |
throttlingBurstLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-burst-limit |
throttlingRateLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-rate-limit |
tracingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :tracing-enabled |
variables | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :variables |
The build-cfn-deployment-stage-description-property-builder function updates a CfnDeployment$StageDescriptionProperty$Builder instance using the provided configuration. The function takes the CfnDeployment$StageDescriptionProperty$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 | |---|---|---|---| | `accessLogSetting` | software.amazon.awscdk.services.apigateway.CfnDeployment$AccessLogSettingProperty | [[cdk.support/lookup-entry]] | `:access-log-setting` | | `cacheClusterEnabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:cache-cluster-enabled` | | `cacheClusterSize` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-cluster-size` | | `cacheDataEncrypted` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-data-encrypted` | | `cacheTtlInSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:cache-ttl-in-seconds` | | `cachingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:caching-enabled` | | `canarySetting` | software.amazon.awscdk.services.apigateway.CfnDeployment$CanarySettingProperty | [[cdk.support/lookup-entry]] | `:canary-setting` | | `clientCertificateId` | java.lang.String | [[cdk.support/lookup-entry]] | `:client-certificate-id` | | `dataTraceEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:data-trace-enabled` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `documentationVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:documentation-version` | | `loggingLevel` | java.lang.String | [[cdk.support/lookup-entry]] | `:logging-level` | | `methodSettings` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:method-settings` | | `metricsEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:metrics-enabled` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `throttlingBurstLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-burst-limit` | | `throttlingRateLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-rate-limit` | | `tracingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:tracing-enabled` | | `variables` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:variables` |
(build-cfn-documentation-part-builder builder id config)
The build-cfn-documentation-part-builder function updates a CfnDocumentationPart$Builder instance using the provided configuration. The function takes the CfnDocumentationPart$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 |
---|---|---|---|
location | software.amazon.awscdk.services.apigateway.CfnDocumentationPart$LocationProperty | cdk.support/lookup-entry | :location |
properties | java.lang.String | cdk.support/lookup-entry | :properties |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
The build-cfn-documentation-part-builder function updates a CfnDocumentationPart$Builder instance using the provided configuration. The function takes the CfnDocumentationPart$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 | |---|---|---|---| | `location` | software.amazon.awscdk.services.apigateway.CfnDocumentationPart$LocationProperty | [[cdk.support/lookup-entry]] | `:location` | | `properties` | java.lang.String | [[cdk.support/lookup-entry]] | `:properties` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` |
(build-cfn-documentation-part-location-property-builder builder id config)
The build-cfn-documentation-part-location-property-builder function updates a CfnDocumentationPart$LocationProperty$Builder instance using the provided configuration. The function takes the CfnDocumentationPart$LocationProperty$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 |
---|---|---|---|
method | java.lang.String | cdk.support/lookup-entry | :method |
name | java.lang.String | cdk.support/lookup-entry | :name |
path | java.lang.String | cdk.support/lookup-entry | :path |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
type | java.lang.String | cdk.support/lookup-entry | :type |
The build-cfn-documentation-part-location-property-builder function updates a CfnDocumentationPart$LocationProperty$Builder instance using the provided configuration. The function takes the CfnDocumentationPart$LocationProperty$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 | |---|---|---|---| | `method` | java.lang.String | [[cdk.support/lookup-entry]] | `:method` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `path` | java.lang.String | [[cdk.support/lookup-entry]] | `:path` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` | | `type` | java.lang.String | [[cdk.support/lookup-entry]] | `:type` |
(build-cfn-documentation-part-props-builder builder id config)
The build-cfn-documentation-part-props-builder function updates a CfnDocumentationPartProps$Builder instance using the provided configuration. The function takes the CfnDocumentationPartProps$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 |
---|---|---|---|
location | software.amazon.awscdk.services.apigateway.CfnDocumentationPart$LocationProperty | cdk.support/lookup-entry | :location |
properties | java.lang.String | cdk.support/lookup-entry | :properties |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
The build-cfn-documentation-part-props-builder function updates a CfnDocumentationPartProps$Builder instance using the provided configuration. The function takes the CfnDocumentationPartProps$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 | |---|---|---|---| | `location` | software.amazon.awscdk.services.apigateway.CfnDocumentationPart$LocationProperty | [[cdk.support/lookup-entry]] | `:location` | | `properties` | java.lang.String | [[cdk.support/lookup-entry]] | `:properties` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` |
(build-cfn-documentation-version-builder builder id config)
The build-cfn-documentation-version-builder function updates a CfnDocumentationVersion$Builder instance using the provided configuration. The function takes the CfnDocumentationVersion$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
documentationVersion | java.lang.String | cdk.support/lookup-entry | :documentation-version |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
The build-cfn-documentation-version-builder function updates a CfnDocumentationVersion$Builder instance using the provided configuration. The function takes the CfnDocumentationVersion$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `documentationVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:documentation-version` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` |
(build-cfn-documentation-version-props-builder builder id config)
The build-cfn-documentation-version-props-builder function updates a CfnDocumentationVersionProps$Builder instance using the provided configuration. The function takes the CfnDocumentationVersionProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
documentationVersion | java.lang.String | cdk.support/lookup-entry | :documentation-version |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
The build-cfn-documentation-version-props-builder function updates a CfnDocumentationVersionProps$Builder instance using the provided configuration. The function takes the CfnDocumentationVersionProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `documentationVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:documentation-version` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` |
(build-cfn-domain-name-builder builder id config)
The build-cfn-domain-name-builder function updates a CfnDomainName$Builder instance using the provided configuration. The function takes the CfnDomainName$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 |
---|---|---|---|
certificateArn | java.lang.String | cdk.support/lookup-entry | :certificate-arn |
domainName | java.lang.String | cdk.support/lookup-entry | :domain-name |
endpointConfiguration | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :endpoint-configuration |
mutualTlsAuthentication | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :mutual-tls-authentication |
ownershipVerificationCertificateArn | java.lang.String | cdk.support/lookup-entry | :ownership-verification-certificate-arn |
regionalCertificateArn | java.lang.String | cdk.support/lookup-entry | :regional-certificate-arn |
securityPolicy | java.lang.String | cdk.support/lookup-entry | :security-policy |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-domain-name-builder function updates a CfnDomainName$Builder instance using the provided configuration. The function takes the CfnDomainName$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 | |---|---|---|---| | `certificateArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:certificate-arn` | | `domainName` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointConfiguration` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `mutualTlsAuthentication` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:mutual-tls-authentication` | | `ownershipVerificationCertificateArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:ownership-verification-certificate-arn` | | `regionalCertificateArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:regional-certificate-arn` | | `securityPolicy` | java.lang.String | [[cdk.support/lookup-entry]] | `:security-policy` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-cfn-domain-name-endpoint-configuration-property-builder builder
id
config)
The build-cfn-domain-name-endpoint-configuration-property-builder function updates a CfnDomainName$EndpointConfigurationProperty$Builder instance using the provided configuration. The function takes the CfnDomainName$EndpointConfigurationProperty$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 |
---|---|---|---|
types | java.util.List | cdk.support/lookup-entry | :types |
The build-cfn-domain-name-endpoint-configuration-property-builder function updates a CfnDomainName$EndpointConfigurationProperty$Builder instance using the provided configuration. The function takes the CfnDomainName$EndpointConfigurationProperty$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 | |---|---|---|---| | `types` | java.util.List | [[cdk.support/lookup-entry]] | `:types` |
(build-cfn-domain-name-mutual-tls-authentication-property-builder builder
id
config)
The build-cfn-domain-name-mutual-tls-authentication-property-builder function updates a CfnDomainName$MutualTlsAuthenticationProperty$Builder instance using the provided configuration. The function takes the CfnDomainName$MutualTlsAuthenticationProperty$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 |
---|---|---|---|
truststoreUri | java.lang.String | cdk.support/lookup-entry | :truststore-uri |
truststoreVersion | java.lang.String | cdk.support/lookup-entry | :truststore-version |
The build-cfn-domain-name-mutual-tls-authentication-property-builder function updates a CfnDomainName$MutualTlsAuthenticationProperty$Builder instance using the provided configuration. The function takes the CfnDomainName$MutualTlsAuthenticationProperty$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 | |---|---|---|---| | `truststoreUri` | java.lang.String | [[cdk.support/lookup-entry]] | `:truststore-uri` | | `truststoreVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:truststore-version` |
(build-cfn-domain-name-props-builder builder id config)
The build-cfn-domain-name-props-builder function updates a CfnDomainNameProps$Builder instance using the provided configuration. The function takes the CfnDomainNameProps$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 |
---|---|---|---|
certificateArn | java.lang.String | cdk.support/lookup-entry | :certificate-arn |
domainName | java.lang.String | cdk.support/lookup-entry | :domain-name |
endpointConfiguration | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :endpoint-configuration |
mutualTlsAuthentication | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :mutual-tls-authentication |
ownershipVerificationCertificateArn | java.lang.String | cdk.support/lookup-entry | :ownership-verification-certificate-arn |
regionalCertificateArn | java.lang.String | cdk.support/lookup-entry | :regional-certificate-arn |
securityPolicy | java.lang.String | cdk.support/lookup-entry | :security-policy |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-domain-name-props-builder function updates a CfnDomainNameProps$Builder instance using the provided configuration. The function takes the CfnDomainNameProps$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 | |---|---|---|---| | `certificateArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:certificate-arn` | | `domainName` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointConfiguration` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `mutualTlsAuthentication` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:mutual-tls-authentication` | | `ownershipVerificationCertificateArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:ownership-verification-certificate-arn` | | `regionalCertificateArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:regional-certificate-arn` | | `securityPolicy` | java.lang.String | [[cdk.support/lookup-entry]] | `:security-policy` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-cfn-gateway-response-builder builder id config)
The build-cfn-gateway-response-builder function updates a CfnGatewayResponse$Builder instance using the provided configuration. The function takes the CfnGatewayResponse$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 |
---|---|---|---|
responseParameters | java.util.Map | cdk.support/lookup-entry | :response-parameters |
responseTemplates | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :response-templates |
responseType | java.lang.String | cdk.support/lookup-entry | :response-type |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
The build-cfn-gateway-response-builder function updates a CfnGatewayResponse$Builder instance using the provided configuration. The function takes the CfnGatewayResponse$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 | |---|---|---|---| | `responseParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-parameters` | | `responseTemplates` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:response-templates` | | `responseType` | java.lang.String | [[cdk.support/lookup-entry]] | `:response-type` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` |
(build-cfn-gateway-response-props-builder builder id config)
The build-cfn-gateway-response-props-builder function updates a CfnGatewayResponseProps$Builder instance using the provided configuration. The function takes the CfnGatewayResponseProps$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 |
---|---|---|---|
responseParameters | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :response-parameters |
responseTemplates | java.util.Map | cdk.support/lookup-entry | :response-templates |
responseType | java.lang.String | cdk.support/lookup-entry | :response-type |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
The build-cfn-gateway-response-props-builder function updates a CfnGatewayResponseProps$Builder instance using the provided configuration. The function takes the CfnGatewayResponseProps$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 | |---|---|---|---| | `responseParameters` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:response-parameters` | | `responseTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-templates` | | `responseType` | java.lang.String | [[cdk.support/lookup-entry]] | `:response-type` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` |
(build-cfn-method-builder builder id config)
The build-cfn-method-builder function updates a CfnMethod$Builder instance using the provided configuration. The function takes the CfnMethod$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 |
---|---|---|---|
apiKeyRequired | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :api-key-required |
authorizationScopes | java.util.List | cdk.support/lookup-entry | :authorization-scopes |
authorizationType | java.lang.String | cdk.support/lookup-entry | :authorization-type |
authorizerId | java.lang.String | cdk.support/lookup-entry | :authorizer-id |
httpMethod | java.lang.String | cdk.support/lookup-entry | :http-method |
integration | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :integration |
methodResponses | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :method-responses |
operationName | java.lang.String | cdk.support/lookup-entry | :operation-name |
requestModels | java.util.Map | cdk.support/lookup-entry | :request-models |
requestParameters | java.util.Map | cdk.support/lookup-entry | :request-parameters |
requestValidatorId | java.lang.String | cdk.support/lookup-entry | :request-validator-id |
resourceId | java.lang.String | cdk.support/lookup-entry | :resource-id |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
The build-cfn-method-builder function updates a CfnMethod$Builder instance using the provided configuration. The function takes the CfnMethod$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 | |---|---|---|---| | `apiKeyRequired` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:api-key-required` | | `authorizationScopes` | java.util.List | [[cdk.support/lookup-entry]] | `:authorization-scopes` | | `authorizationType` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorization-type` | | `authorizerId` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-id` | | `httpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:http-method` | | `integration` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:integration` | | `methodResponses` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:method-responses` | | `operationName` | java.lang.String | [[cdk.support/lookup-entry]] | `:operation-name` | | `requestModels` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-models` | | `requestParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestValidatorId` | java.lang.String | [[cdk.support/lookup-entry]] | `:request-validator-id` | | `resourceId` | java.lang.String | [[cdk.support/lookup-entry]] | `:resource-id` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` |
(build-cfn-method-integration-property-builder builder id config)
The build-cfn-method-integration-property-builder function updates a CfnMethod$IntegrationProperty$Builder instance using the provided configuration. The function takes the CfnMethod$IntegrationProperty$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 |
---|---|---|---|
cacheKeyParameters | java.util.List | cdk.support/lookup-entry | :cache-key-parameters |
cacheNamespace | java.lang.String | cdk.support/lookup-entry | :cache-namespace |
connectionId | java.lang.String | cdk.support/lookup-entry | :connection-id |
connectionType | java.lang.String | cdk.support/lookup-entry | :connection-type |
contentHandling | java.lang.String | cdk.support/lookup-entry | :content-handling |
credentials | java.lang.String | cdk.support/lookup-entry | :credentials |
integrationHttpMethod | java.lang.String | cdk.support/lookup-entry | :integration-http-method |
integrationResponses | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :integration-responses |
passthroughBehavior | java.lang.String | cdk.support/lookup-entry | :passthrough-behavior |
requestParameters | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :request-parameters |
requestTemplates | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :request-templates |
timeoutInMillis | java.lang.Number | cdk.support/lookup-entry | :timeout-in-millis |
type | java.lang.String | cdk.support/lookup-entry | :type |
uri | java.lang.String | cdk.support/lookup-entry | :uri |
The build-cfn-method-integration-property-builder function updates a CfnMethod$IntegrationProperty$Builder instance using the provided configuration. The function takes the CfnMethod$IntegrationProperty$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 | |---|---|---|---| | `cacheKeyParameters` | java.util.List | [[cdk.support/lookup-entry]] | `:cache-key-parameters` | | `cacheNamespace` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-namespace` | | `connectionId` | java.lang.String | [[cdk.support/lookup-entry]] | `:connection-id` | | `connectionType` | java.lang.String | [[cdk.support/lookup-entry]] | `:connection-type` | | `contentHandling` | java.lang.String | [[cdk.support/lookup-entry]] | `:content-handling` | | `credentials` | java.lang.String | [[cdk.support/lookup-entry]] | `:credentials` | | `integrationHttpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:integration-http-method` | | `integrationResponses` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:integration-responses` | | `passthroughBehavior` | java.lang.String | [[cdk.support/lookup-entry]] | `:passthrough-behavior` | | `requestParameters` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestTemplates` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:request-templates` | | `timeoutInMillis` | java.lang.Number | [[cdk.support/lookup-entry]] | `:timeout-in-millis` | | `type` | java.lang.String | [[cdk.support/lookup-entry]] | `:type` | | `uri` | java.lang.String | [[cdk.support/lookup-entry]] | `:uri` |
(build-cfn-method-integration-response-property-builder builder id config)
The build-cfn-method-integration-response-property-builder function updates a CfnMethod$IntegrationResponseProperty$Builder instance using the provided configuration. The function takes the CfnMethod$IntegrationResponseProperty$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 |
---|---|---|---|
contentHandling | java.lang.String | cdk.support/lookup-entry | :content-handling |
responseParameters | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :response-parameters |
responseTemplates | java.util.Map | cdk.support/lookup-entry | :response-templates |
selectionPattern | java.lang.String | cdk.support/lookup-entry | :selection-pattern |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
The build-cfn-method-integration-response-property-builder function updates a CfnMethod$IntegrationResponseProperty$Builder instance using the provided configuration. The function takes the CfnMethod$IntegrationResponseProperty$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 | |---|---|---|---| | `contentHandling` | java.lang.String | [[cdk.support/lookup-entry]] | `:content-handling` | | `responseParameters` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:response-parameters` | | `responseTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-templates` | | `selectionPattern` | java.lang.String | [[cdk.support/lookup-entry]] | `:selection-pattern` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` |
(build-cfn-method-method-response-property-builder builder id config)
The build-cfn-method-method-response-property-builder function updates a CfnMethod$MethodResponseProperty$Builder instance using the provided configuration. The function takes the CfnMethod$MethodResponseProperty$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 |
---|---|---|---|
responseModels | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :response-models |
responseParameters | java.util.Map | cdk.support/lookup-entry | :response-parameters |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
The build-cfn-method-method-response-property-builder function updates a CfnMethod$MethodResponseProperty$Builder instance using the provided configuration. The function takes the CfnMethod$MethodResponseProperty$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 | |---|---|---|---| | `responseModels` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:response-models` | | `responseParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-parameters` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` |
(build-cfn-method-props-builder builder id config)
The build-cfn-method-props-builder function updates a CfnMethodProps$Builder instance using the provided configuration. The function takes the CfnMethodProps$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 |
---|---|---|---|
apiKeyRequired | java.lang.Boolean | cdk.support/lookup-entry | :api-key-required |
authorizationScopes | java.util.List | cdk.support/lookup-entry | :authorization-scopes |
authorizationType | java.lang.String | cdk.support/lookup-entry | :authorization-type |
authorizerId | java.lang.String | cdk.support/lookup-entry | :authorizer-id |
httpMethod | java.lang.String | cdk.support/lookup-entry | :http-method |
integration | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :integration |
methodResponses | java.util.List | cdk.support/lookup-entry | :method-responses |
operationName | java.lang.String | cdk.support/lookup-entry | :operation-name |
requestModels | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :request-models |
requestParameters | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :request-parameters |
requestValidatorId | java.lang.String | cdk.support/lookup-entry | :request-validator-id |
resourceId | java.lang.String | cdk.support/lookup-entry | :resource-id |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
The build-cfn-method-props-builder function updates a CfnMethodProps$Builder instance using the provided configuration. The function takes the CfnMethodProps$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 | |---|---|---|---| | `apiKeyRequired` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:api-key-required` | | `authorizationScopes` | java.util.List | [[cdk.support/lookup-entry]] | `:authorization-scopes` | | `authorizationType` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorization-type` | | `authorizerId` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-id` | | `httpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:http-method` | | `integration` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:integration` | | `methodResponses` | java.util.List | [[cdk.support/lookup-entry]] | `:method-responses` | | `operationName` | java.lang.String | [[cdk.support/lookup-entry]] | `:operation-name` | | `requestModels` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:request-models` | | `requestParameters` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestValidatorId` | java.lang.String | [[cdk.support/lookup-entry]] | `:request-validator-id` | | `resourceId` | java.lang.String | [[cdk.support/lookup-entry]] | `:resource-id` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` |
(build-cfn-model-builder builder id config)
The build-cfn-model-builder function updates a CfnModel$Builder instance using the provided configuration. The function takes the CfnModel$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 |
---|---|---|---|
contentType | java.lang.String | cdk.support/lookup-entry | :content-type |
description | java.lang.String | cdk.support/lookup-entry | :description |
name | java.lang.String | cdk.support/lookup-entry | :name |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
schema | java.lang.Object | cdk.support/lookup-entry | :schema |
The build-cfn-model-builder function updates a CfnModel$Builder instance using the provided configuration. The function takes the CfnModel$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 | |---|---|---|---| | `contentType` | java.lang.String | [[cdk.support/lookup-entry]] | `:content-type` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `schema` | java.lang.Object | [[cdk.support/lookup-entry]] | `:schema` |
(build-cfn-model-props-builder builder id config)
The build-cfn-model-props-builder function updates a CfnModelProps$Builder instance using the provided configuration. The function takes the CfnModelProps$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 |
---|---|---|---|
contentType | java.lang.String | cdk.support/lookup-entry | :content-type |
description | java.lang.String | cdk.support/lookup-entry | :description |
name | java.lang.String | cdk.support/lookup-entry | :name |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
schema | java.lang.Object | cdk.support/lookup-entry | :schema |
The build-cfn-model-props-builder function updates a CfnModelProps$Builder instance using the provided configuration. The function takes the CfnModelProps$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 | |---|---|---|---| | `contentType` | java.lang.String | [[cdk.support/lookup-entry]] | `:content-type` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `schema` | java.lang.Object | [[cdk.support/lookup-entry]] | `:schema` |
(build-cfn-request-validator-builder builder id config)
The build-cfn-request-validator-builder function updates a CfnRequestValidator$Builder instance using the provided configuration. The function takes the CfnRequestValidator$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 |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
validateRequestBody | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :validate-request-body |
validateRequestParameters | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :validate-request-parameters |
The build-cfn-request-validator-builder function updates a CfnRequestValidator$Builder instance using the provided configuration. The function takes the CfnRequestValidator$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` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `validateRequestBody` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:validate-request-body` | | `validateRequestParameters` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:validate-request-parameters` |
(build-cfn-request-validator-props-builder builder id config)
The build-cfn-request-validator-props-builder function updates a CfnRequestValidatorProps$Builder instance using the provided configuration. The function takes the CfnRequestValidatorProps$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 |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
validateRequestBody | java.lang.Boolean | cdk.support/lookup-entry | :validate-request-body |
validateRequestParameters | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :validate-request-parameters |
The build-cfn-request-validator-props-builder function updates a CfnRequestValidatorProps$Builder instance using the provided configuration. The function takes the CfnRequestValidatorProps$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` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `validateRequestBody` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:validate-request-body` | | `validateRequestParameters` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:validate-request-parameters` |
(build-cfn-resource-builder builder id config)
The build-cfn-resource-builder function updates a CfnResource$Builder instance using the provided configuration. The function takes the CfnResource$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 |
---|---|---|---|
parentId | java.lang.String | cdk.support/lookup-entry | :parent-id |
pathPart | java.lang.String | cdk.support/lookup-entry | :path-part |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
The build-cfn-resource-builder function updates a CfnResource$Builder instance using the provided configuration. The function takes the CfnResource$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 | |---|---|---|---| | `parentId` | java.lang.String | [[cdk.support/lookup-entry]] | `:parent-id` | | `pathPart` | java.lang.String | [[cdk.support/lookup-entry]] | `:path-part` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` |
(build-cfn-resource-props-builder builder id config)
The build-cfn-resource-props-builder function updates a CfnResourceProps$Builder instance using the provided configuration. The function takes the CfnResourceProps$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 |
---|---|---|---|
parentId | java.lang.String | cdk.support/lookup-entry | :parent-id |
pathPart | java.lang.String | cdk.support/lookup-entry | :path-part |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
The build-cfn-resource-props-builder function updates a CfnResourceProps$Builder instance using the provided configuration. The function takes the CfnResourceProps$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 | |---|---|---|---| | `parentId` | java.lang.String | [[cdk.support/lookup-entry]] | `:parent-id` | | `pathPart` | java.lang.String | [[cdk.support/lookup-entry]] | `:path-part` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` |
(build-cfn-rest-api-builder builder id config)
The build-cfn-rest-api-builder function updates a CfnRestApi$Builder instance using the provided configuration. The function takes the CfnRestApi$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 |
---|---|---|---|
apiKeySourceType | java.lang.String | cdk.support/lookup-entry | :api-key-source-type |
binaryMediaTypes | java.util.List | cdk.support/lookup-entry | :binary-media-types |
body | java.lang.Object | cdk.support/lookup-entry | :body |
bodyS3Location | software.amazon.awscdk.services.apigateway.CfnRestApi$S3LocationProperty | cdk.support/lookup-entry | :body-s3-location |
cloneFrom | java.lang.String | cdk.support/lookup-entry | :clone-from |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
endpointConfiguration | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :endpoint-configuration |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
minimumCompressionSize | java.lang.Number | cdk.support/lookup-entry | :minimum-compression-size |
mode | java.lang.String | cdk.support/lookup-entry | :mode |
name | java.lang.String | cdk.support/lookup-entry | :name |
parameters | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :parameters |
policy | java.lang.Object | cdk.support/lookup-entry | :policy |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-rest-api-builder function updates a CfnRestApi$Builder instance using the provided configuration. The function takes the CfnRestApi$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 | |---|---|---|---| | `apiKeySourceType` | java.lang.String | [[cdk.support/lookup-entry]] | `:api-key-source-type` | | `binaryMediaTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:binary-media-types` | | `body` | java.lang.Object | [[cdk.support/lookup-entry]] | `:body` | | `bodyS3Location` | software.amazon.awscdk.services.apigateway.CfnRestApi$S3LocationProperty | [[cdk.support/lookup-entry]] | `:body-s3-location` | | `cloneFrom` | java.lang.String | [[cdk.support/lookup-entry]] | `:clone-from` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `endpointConfiguration` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `minimumCompressionSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:minimum-compression-size` | | `mode` | java.lang.String | [[cdk.support/lookup-entry]] | `:mode` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `parameters` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:parameters` | | `policy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:policy` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-cfn-rest-api-endpoint-configuration-property-builder builder id config)
The build-cfn-rest-api-endpoint-configuration-property-builder function updates a CfnRestApi$EndpointConfigurationProperty$Builder instance using the provided configuration. The function takes the CfnRestApi$EndpointConfigurationProperty$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 |
---|---|---|---|
types | java.util.List | cdk.support/lookup-entry | :types |
vpcEndpointIds | java.util.List | cdk.support/lookup-entry | :vpc-endpoint-ids |
The build-cfn-rest-api-endpoint-configuration-property-builder function updates a CfnRestApi$EndpointConfigurationProperty$Builder instance using the provided configuration. The function takes the CfnRestApi$EndpointConfigurationProperty$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 | |---|---|---|---| | `types` | java.util.List | [[cdk.support/lookup-entry]] | `:types` | | `vpcEndpointIds` | java.util.List | [[cdk.support/lookup-entry]] | `:vpc-endpoint-ids` |
(build-cfn-rest-api-props-builder builder id config)
The build-cfn-rest-api-props-builder function updates a CfnRestApiProps$Builder instance using the provided configuration. The function takes the CfnRestApiProps$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 |
---|---|---|---|
apiKeySourceType | java.lang.String | cdk.support/lookup-entry | :api-key-source-type |
binaryMediaTypes | java.util.List | cdk.support/lookup-entry | :binary-media-types |
body | java.lang.Object | cdk.support/lookup-entry | :body |
bodyS3Location | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :body-s3-location |
cloneFrom | java.lang.String | cdk.support/lookup-entry | :clone-from |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :disable-execute-api-endpoint |
endpointConfiguration | software.amazon.awscdk.services.apigateway.CfnRestApi$EndpointConfigurationProperty | cdk.support/lookup-entry | :endpoint-configuration |
failOnWarnings | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :fail-on-warnings |
minimumCompressionSize | java.lang.Number | cdk.support/lookup-entry | :minimum-compression-size |
mode | java.lang.String | cdk.support/lookup-entry | :mode |
name | java.lang.String | cdk.support/lookup-entry | :name |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
policy | java.lang.Object | cdk.support/lookup-entry | :policy |
tags | java.util.List | cdk.support/lookup-entry | :tags |
The build-cfn-rest-api-props-builder function updates a CfnRestApiProps$Builder instance using the provided configuration. The function takes the CfnRestApiProps$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 | |---|---|---|---| | `apiKeySourceType` | java.lang.String | [[cdk.support/lookup-entry]] | `:api-key-source-type` | | `binaryMediaTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:binary-media-types` | | `body` | java.lang.Object | [[cdk.support/lookup-entry]] | `:body` | | `bodyS3Location` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:body-s3-location` | | `cloneFrom` | java.lang.String | [[cdk.support/lookup-entry]] | `:clone-from` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `endpointConfiguration` | software.amazon.awscdk.services.apigateway.CfnRestApi$EndpointConfigurationProperty | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `failOnWarnings` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `minimumCompressionSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:minimum-compression-size` | | `mode` | java.lang.String | [[cdk.support/lookup-entry]] | `:mode` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `policy` | java.lang.Object | [[cdk.support/lookup-entry]] | `:policy` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` |
(build-cfn-rest-api-s3-location-property-builder builder id config)
The build-cfn-rest-api-s3-location-property-builder function updates a CfnRestApi$S3LocationProperty$Builder instance using the provided configuration. The function takes the CfnRestApi$S3LocationProperty$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 | java.lang.String | cdk.support/lookup-entry | :bucket |
eTag | java.lang.String | cdk.support/lookup-entry | :e-tag |
key | java.lang.String | cdk.support/lookup-entry | :key |
version | java.lang.String | cdk.support/lookup-entry | :version |
The build-cfn-rest-api-s3-location-property-builder function updates a CfnRestApi$S3LocationProperty$Builder instance using the provided configuration. The function takes the CfnRestApi$S3LocationProperty$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` | java.lang.String | [[cdk.support/lookup-entry]] | `:bucket` | | `eTag` | java.lang.String | [[cdk.support/lookup-entry]] | `:e-tag` | | `key` | java.lang.String | [[cdk.support/lookup-entry]] | `:key` | | `version` | java.lang.String | [[cdk.support/lookup-entry]] | `:version` |
(build-cfn-stage-access-log-setting-property-builder builder id config)
The build-cfn-stage-access-log-setting-property-builder function updates a CfnStage$AccessLogSettingProperty$Builder instance using the provided configuration. The function takes the CfnStage$AccessLogSettingProperty$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 |
---|---|---|---|
destinationArn | java.lang.String | cdk.support/lookup-entry | :destination-arn |
format | java.lang.String | cdk.support/lookup-entry | :format |
The build-cfn-stage-access-log-setting-property-builder function updates a CfnStage$AccessLogSettingProperty$Builder instance using the provided configuration. The function takes the CfnStage$AccessLogSettingProperty$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 | |---|---|---|---| | `destinationArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:destination-arn` | | `format` | java.lang.String | [[cdk.support/lookup-entry]] | `:format` |
(build-cfn-stage-builder builder id config)
The build-cfn-stage-builder function updates a CfnStage$Builder instance using the provided configuration. The function takes the CfnStage$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 |
---|---|---|---|
accessLogSetting | software.amazon.awscdk.services.apigateway.CfnStage$AccessLogSettingProperty | cdk.support/lookup-entry | :access-log-setting |
cacheClusterEnabled | java.lang.Boolean | cdk.support/lookup-entry | :cache-cluster-enabled |
cacheClusterSize | java.lang.String | cdk.support/lookup-entry | :cache-cluster-size |
canarySetting | software.amazon.awscdk.services.apigateway.CfnStage$CanarySettingProperty | cdk.support/lookup-entry | :canary-setting |
clientCertificateId | java.lang.String | cdk.support/lookup-entry | :client-certificate-id |
deploymentId | java.lang.String | cdk.support/lookup-entry | :deployment-id |
description | java.lang.String | cdk.support/lookup-entry | :description |
documentationVersion | java.lang.String | cdk.support/lookup-entry | :documentation-version |
methodSettings | java.util.List | cdk.support/lookup-entry | :method-settings |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
tags | java.util.List | cdk.support/lookup-entry | :tags |
tracingEnabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :tracing-enabled |
variables | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :variables |
The build-cfn-stage-builder function updates a CfnStage$Builder instance using the provided configuration. The function takes the CfnStage$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 | |---|---|---|---| | `accessLogSetting` | software.amazon.awscdk.services.apigateway.CfnStage$AccessLogSettingProperty | [[cdk.support/lookup-entry]] | `:access-log-setting` | | `cacheClusterEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-cluster-enabled` | | `cacheClusterSize` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-cluster-size` | | `canarySetting` | software.amazon.awscdk.services.apigateway.CfnStage$CanarySettingProperty | [[cdk.support/lookup-entry]] | `:canary-setting` | | `clientCertificateId` | java.lang.String | [[cdk.support/lookup-entry]] | `:client-certificate-id` | | `deploymentId` | java.lang.String | [[cdk.support/lookup-entry]] | `:deployment-id` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `documentationVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:documentation-version` | | `methodSettings` | java.util.List | [[cdk.support/lookup-entry]] | `:method-settings` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `tracingEnabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:tracing-enabled` | | `variables` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:variables` |
(build-cfn-stage-canary-setting-property-builder builder id config)
The build-cfn-stage-canary-setting-property-builder function updates a CfnStage$CanarySettingProperty$Builder instance using the provided configuration. The function takes the CfnStage$CanarySettingProperty$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 |
---|---|---|---|
deploymentId | java.lang.String | cdk.support/lookup-entry | :deployment-id |
percentTraffic | java.lang.Number | cdk.support/lookup-entry | :percent-traffic |
stageVariableOverrides | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :stage-variable-overrides |
useStageCache | java.lang.Boolean | cdk.support/lookup-entry | :use-stage-cache |
The build-cfn-stage-canary-setting-property-builder function updates a CfnStage$CanarySettingProperty$Builder instance using the provided configuration. The function takes the CfnStage$CanarySettingProperty$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 | |---|---|---|---| | `deploymentId` | java.lang.String | [[cdk.support/lookup-entry]] | `:deployment-id` | | `percentTraffic` | java.lang.Number | [[cdk.support/lookup-entry]] | `:percent-traffic` | | `stageVariableOverrides` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:stage-variable-overrides` | | `useStageCache` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:use-stage-cache` |
(build-cfn-stage-method-setting-property-builder builder id config)
The build-cfn-stage-method-setting-property-builder function updates a CfnStage$MethodSettingProperty$Builder instance using the provided configuration. The function takes the CfnStage$MethodSettingProperty$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 |
---|---|---|---|
cacheDataEncrypted | java.lang.Boolean | cdk.support/lookup-entry | :cache-data-encrypted |
cacheTtlInSeconds | java.lang.Number | cdk.support/lookup-entry | :cache-ttl-in-seconds |
cachingEnabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :caching-enabled |
dataTraceEnabled | java.lang.Boolean | cdk.support/lookup-entry | :data-trace-enabled |
httpMethod | java.lang.String | cdk.support/lookup-entry | :http-method |
loggingLevel | java.lang.String | cdk.support/lookup-entry | :logging-level |
metricsEnabled | java.lang.Boolean | cdk.support/lookup-entry | :metrics-enabled |
resourcePath | java.lang.String | cdk.support/lookup-entry | :resource-path |
throttlingBurstLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-burst-limit |
throttlingRateLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-rate-limit |
The build-cfn-stage-method-setting-property-builder function updates a CfnStage$MethodSettingProperty$Builder instance using the provided configuration. The function takes the CfnStage$MethodSettingProperty$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 | |---|---|---|---| | `cacheDataEncrypted` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-data-encrypted` | | `cacheTtlInSeconds` | java.lang.Number | [[cdk.support/lookup-entry]] | `:cache-ttl-in-seconds` | | `cachingEnabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:caching-enabled` | | `dataTraceEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:data-trace-enabled` | | `httpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:http-method` | | `loggingLevel` | java.lang.String | [[cdk.support/lookup-entry]] | `:logging-level` | | `metricsEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:metrics-enabled` | | `resourcePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:resource-path` | | `throttlingBurstLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-burst-limit` | | `throttlingRateLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-rate-limit` |
(build-cfn-stage-props-builder builder id config)
The build-cfn-stage-props-builder function updates a CfnStageProps$Builder instance using the provided configuration. The function takes the CfnStageProps$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 |
---|---|---|---|
accessLogSetting | software.amazon.awscdk.services.apigateway.CfnStage$AccessLogSettingProperty | cdk.support/lookup-entry | :access-log-setting |
cacheClusterEnabled | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :cache-cluster-enabled |
cacheClusterSize | java.lang.String | cdk.support/lookup-entry | :cache-cluster-size |
canarySetting | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :canary-setting |
clientCertificateId | java.lang.String | cdk.support/lookup-entry | :client-certificate-id |
deploymentId | java.lang.String | cdk.support/lookup-entry | :deployment-id |
description | java.lang.String | cdk.support/lookup-entry | :description |
documentationVersion | java.lang.String | cdk.support/lookup-entry | :documentation-version |
methodSettings | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :method-settings |
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
tags | java.util.List | cdk.support/lookup-entry | :tags |
tracingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :tracing-enabled |
variables | java.util.Map | cdk.support/lookup-entry | :variables |
The build-cfn-stage-props-builder function updates a CfnStageProps$Builder instance using the provided configuration. The function takes the CfnStageProps$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 | |---|---|---|---| | `accessLogSetting` | software.amazon.awscdk.services.apigateway.CfnStage$AccessLogSettingProperty | [[cdk.support/lookup-entry]] | `:access-log-setting` | | `cacheClusterEnabled` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:cache-cluster-enabled` | | `cacheClusterSize` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-cluster-size` | | `canarySetting` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:canary-setting` | | `clientCertificateId` | java.lang.String | [[cdk.support/lookup-entry]] | `:client-certificate-id` | | `deploymentId` | java.lang.String | [[cdk.support/lookup-entry]] | `:deployment-id` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `documentationVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:documentation-version` | | `methodSettings` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:method-settings` | | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `tracingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:tracing-enabled` | | `variables` | java.util.Map | [[cdk.support/lookup-entry]] | `:variables` |
(build-cfn-usage-plan-api-stage-property-builder builder id config)
The build-cfn-usage-plan-api-stage-property-builder function updates a CfnUsagePlan$ApiStageProperty$Builder instance using the provided configuration. The function takes the CfnUsagePlan$ApiStageProperty$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 |
---|---|---|---|
apiId | java.lang.String | cdk.support/lookup-entry | :api-id |
stage | java.lang.String | cdk.support/lookup-entry | :stage |
throttle | java.util.Map | cdk.support/lookup-entry | :throttle |
The build-cfn-usage-plan-api-stage-property-builder function updates a CfnUsagePlan$ApiStageProperty$Builder instance using the provided configuration. The function takes the CfnUsagePlan$ApiStageProperty$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 | |---|---|---|---| | `apiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:api-id` | | `stage` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage` | | `throttle` | java.util.Map | [[cdk.support/lookup-entry]] | `:throttle` |
(build-cfn-usage-plan-builder builder id config)
The build-cfn-usage-plan-builder function updates a CfnUsagePlan$Builder instance using the provided configuration. The function takes the CfnUsagePlan$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 |
---|---|---|---|
apiStages | java.util.List | cdk.support/lookup-entry | :api-stages |
description | java.lang.String | cdk.support/lookup-entry | :description |
quota | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :quota |
tags | java.util.List | cdk.support/lookup-entry | :tags |
throttle | software.amazon.awscdk.services.apigateway.CfnUsagePlan$ThrottleSettingsProperty | cdk.support/lookup-entry | :throttle |
usagePlanName | java.lang.String | cdk.support/lookup-entry | :usage-plan-name |
The build-cfn-usage-plan-builder function updates a CfnUsagePlan$Builder instance using the provided configuration. The function takes the CfnUsagePlan$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 | |---|---|---|---| | `apiStages` | java.util.List | [[cdk.support/lookup-entry]] | `:api-stages` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `quota` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:quota` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `throttle` | software.amazon.awscdk.services.apigateway.CfnUsagePlan$ThrottleSettingsProperty | [[cdk.support/lookup-entry]] | `:throttle` | | `usagePlanName` | java.lang.String | [[cdk.support/lookup-entry]] | `:usage-plan-name` |
(build-cfn-usage-plan-key-builder builder id config)
The build-cfn-usage-plan-key-builder function updates a CfnUsagePlanKey$Builder instance using the provided configuration. The function takes the CfnUsagePlanKey$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 |
---|---|---|---|
keyId | java.lang.String | cdk.support/lookup-entry | :key-id |
keyType | java.lang.String | cdk.support/lookup-entry | :key-type |
usagePlanId | java.lang.String | cdk.support/lookup-entry | :usage-plan-id |
The build-cfn-usage-plan-key-builder function updates a CfnUsagePlanKey$Builder instance using the provided configuration. The function takes the CfnUsagePlanKey$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 | |---|---|---|---| | `keyId` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-id` | | `keyType` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-type` | | `usagePlanId` | java.lang.String | [[cdk.support/lookup-entry]] | `:usage-plan-id` |
(build-cfn-usage-plan-key-props-builder builder id config)
The build-cfn-usage-plan-key-props-builder function updates a CfnUsagePlanKeyProps$Builder instance using the provided configuration. The function takes the CfnUsagePlanKeyProps$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 |
---|---|---|---|
keyId | java.lang.String | cdk.support/lookup-entry | :key-id |
keyType | java.lang.String | cdk.support/lookup-entry | :key-type |
usagePlanId | java.lang.String | cdk.support/lookup-entry | :usage-plan-id |
The build-cfn-usage-plan-key-props-builder function updates a CfnUsagePlanKeyProps$Builder instance using the provided configuration. The function takes the CfnUsagePlanKeyProps$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 | |---|---|---|---| | `keyId` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-id` | | `keyType` | java.lang.String | [[cdk.support/lookup-entry]] | `:key-type` | | `usagePlanId` | java.lang.String | [[cdk.support/lookup-entry]] | `:usage-plan-id` |
(build-cfn-usage-plan-props-builder builder id config)
The build-cfn-usage-plan-props-builder function updates a CfnUsagePlanProps$Builder instance using the provided configuration. The function takes the CfnUsagePlanProps$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 |
---|---|---|---|
apiStages | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :api-stages |
description | java.lang.String | cdk.support/lookup-entry | :description |
quota | software.amazon.awscdk.services.apigateway.CfnUsagePlan$QuotaSettingsProperty | cdk.support/lookup-entry | :quota |
tags | java.util.List | cdk.support/lookup-entry | :tags |
throttle | software.amazon.awscdk.services.apigateway.CfnUsagePlan$ThrottleSettingsProperty | cdk.support/lookup-entry | :throttle |
usagePlanName | java.lang.String | cdk.support/lookup-entry | :usage-plan-name |
The build-cfn-usage-plan-props-builder function updates a CfnUsagePlanProps$Builder instance using the provided configuration. The function takes the CfnUsagePlanProps$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 | |---|---|---|---| | `apiStages` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:api-stages` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `quota` | software.amazon.awscdk.services.apigateway.CfnUsagePlan$QuotaSettingsProperty | [[cdk.support/lookup-entry]] | `:quota` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `throttle` | software.amazon.awscdk.services.apigateway.CfnUsagePlan$ThrottleSettingsProperty | [[cdk.support/lookup-entry]] | `:throttle` | | `usagePlanName` | java.lang.String | [[cdk.support/lookup-entry]] | `:usage-plan-name` |
(build-cfn-usage-plan-quota-settings-property-builder builder id config)
The build-cfn-usage-plan-quota-settings-property-builder function updates a CfnUsagePlan$QuotaSettingsProperty$Builder instance using the provided configuration. The function takes the CfnUsagePlan$QuotaSettingsProperty$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 |
---|---|---|---|
limit | java.lang.Number | cdk.support/lookup-entry | :limit |
offset | java.lang.Number | cdk.support/lookup-entry | :offset |
period | java.lang.String | cdk.support/lookup-entry | :period |
The build-cfn-usage-plan-quota-settings-property-builder function updates a CfnUsagePlan$QuotaSettingsProperty$Builder instance using the provided configuration. The function takes the CfnUsagePlan$QuotaSettingsProperty$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 | |---|---|---|---| | `limit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:limit` | | `offset` | java.lang.Number | [[cdk.support/lookup-entry]] | `:offset` | | `period` | java.lang.String | [[cdk.support/lookup-entry]] | `:period` |
(build-cfn-usage-plan-throttle-settings-property-builder builder id config)
The build-cfn-usage-plan-throttle-settings-property-builder function updates a CfnUsagePlan$ThrottleSettingsProperty$Builder instance using the provided configuration. The function takes the CfnUsagePlan$ThrottleSettingsProperty$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 |
---|---|---|---|
burstLimit | java.lang.Number | cdk.support/lookup-entry | :burst-limit |
rateLimit | java.lang.Number | cdk.support/lookup-entry | :rate-limit |
The build-cfn-usage-plan-throttle-settings-property-builder function updates a CfnUsagePlan$ThrottleSettingsProperty$Builder instance using the provided configuration. The function takes the CfnUsagePlan$ThrottleSettingsProperty$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 | |---|---|---|---| | `burstLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:burst-limit` | | `rateLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:rate-limit` |
(build-cfn-vpc-link-builder builder id config)
The build-cfn-vpc-link-builder function updates a CfnVpcLink$Builder instance using the provided configuration. The function takes the CfnVpcLink$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
name | java.lang.String | cdk.support/lookup-entry | :name |
tags | java.util.List | cdk.support/lookup-entry | :tags |
targetArns | java.util.List | cdk.support/lookup-entry | :target-arns |
The build-cfn-vpc-link-builder function updates a CfnVpcLink$Builder instance using the provided configuration. The function takes the CfnVpcLink$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `targetArns` | java.util.List | [[cdk.support/lookup-entry]] | `:target-arns` |
(build-cfn-vpc-link-props-builder builder id config)
The build-cfn-vpc-link-props-builder function updates a CfnVpcLinkProps$Builder instance using the provided configuration. The function takes the CfnVpcLinkProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
name | java.lang.String | cdk.support/lookup-entry | :name |
tags | java.util.List | cdk.support/lookup-entry | :tags |
targetArns | java.util.List | cdk.support/lookup-entry | :target-arns |
The build-cfn-vpc-link-props-builder function updates a CfnVpcLinkProps$Builder instance using the provided configuration. The function takes the CfnVpcLinkProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `tags` | java.util.List | [[cdk.support/lookup-entry]] | `:tags` | | `targetArns` | java.util.List | [[cdk.support/lookup-entry]] | `:target-arns` |
(build-cognito-user-pools-authorizer-builder builder id config)
The build-cognito-user-pools-authorizer-builder function updates a CognitoUserPoolsAuthorizer$Builder instance using the provided configuration. The function takes the CognitoUserPoolsAuthorizer$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 |
---|---|---|---|
authorizerName | java.lang.String | cdk.support/lookup-entry | :authorizer-name |
cognitoUserPools | java.util.List | cdk.support/lookup-entry | :cognito-user-pools |
identitySource | java.lang.String | cdk.support/lookup-entry | :identity-source |
resultsCacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :results-cache-ttl |
The build-cognito-user-pools-authorizer-builder function updates a CognitoUserPoolsAuthorizer$Builder instance using the provided configuration. The function takes the CognitoUserPoolsAuthorizer$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 | |---|---|---|---| | `authorizerName` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-name` | | `cognitoUserPools` | java.util.List | [[cdk.support/lookup-entry]] | `:cognito-user-pools` | | `identitySource` | java.lang.String | [[cdk.support/lookup-entry]] | `:identity-source` | | `resultsCacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:results-cache-ttl` |
(build-cognito-user-pools-authorizer-props-builder builder id config)
The build-cognito-user-pools-authorizer-props-builder function updates a CognitoUserPoolsAuthorizerProps$Builder instance using the provided configuration. The function takes the CognitoUserPoolsAuthorizerProps$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 |
---|---|---|---|
authorizerName | java.lang.String | cdk.support/lookup-entry | :authorizer-name |
cognitoUserPools | java.util.List | cdk.support/lookup-entry | :cognito-user-pools |
identitySource | java.lang.String | cdk.support/lookup-entry | :identity-source |
resultsCacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :results-cache-ttl |
The build-cognito-user-pools-authorizer-props-builder function updates a CognitoUserPoolsAuthorizerProps$Builder instance using the provided configuration. The function takes the CognitoUserPoolsAuthorizerProps$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 | |---|---|---|---| | `authorizerName` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-name` | | `cognitoUserPools` | java.util.List | [[cdk.support/lookup-entry]] | `:cognito-user-pools` | | `identitySource` | java.lang.String | [[cdk.support/lookup-entry]] | `:identity-source` | | `resultsCacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:results-cache-ttl` |
(build-cors-options-builder builder id config)
The build-cors-options-builder function updates a CorsOptions$Builder instance using the provided configuration. The function takes the CorsOptions$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 |
---|---|---|---|
allowCredentials | java.lang.Boolean | cdk.support/lookup-entry | :allow-credentials |
allowHeaders | java.util.List | cdk.support/lookup-entry | :allow-headers |
allowMethods | java.util.List | cdk.support/lookup-entry | :allow-methods |
allowOrigins | java.util.List | cdk.support/lookup-entry | :allow-origins |
disableCache | java.lang.Boolean | cdk.support/lookup-entry | :disable-cache |
exposeHeaders | java.util.List | cdk.support/lookup-entry | :expose-headers |
maxAge | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :max-age |
statusCode | java.lang.Number | cdk.support/lookup-entry | :status-code |
The build-cors-options-builder function updates a CorsOptions$Builder instance using the provided configuration. The function takes the CorsOptions$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 | |---|---|---|---| | `allowCredentials` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:allow-credentials` | | `allowHeaders` | java.util.List | [[cdk.support/lookup-entry]] | `:allow-headers` | | `allowMethods` | java.util.List | [[cdk.support/lookup-entry]] | `:allow-methods` | | `allowOrigins` | java.util.List | [[cdk.support/lookup-entry]] | `:allow-origins` | | `disableCache` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-cache` | | `exposeHeaders` | java.util.List | [[cdk.support/lookup-entry]] | `:expose-headers` | | `maxAge` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:max-age` | | `statusCode` | java.lang.Number | [[cdk.support/lookup-entry]] | `:status-code` |
(build-deployment-builder builder id config)
The build-deployment-builder function updates a Deployment$Builder instance using the provided configuration. The function takes the Deployment$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 |
---|---|---|---|
api | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :api |
description | java.lang.String | cdk.support/lookup-entry | :description |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
The build-deployment-builder function updates a Deployment$Builder instance using the provided configuration. The function takes the Deployment$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 | |---|---|---|---| | `api` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:api` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` |
(build-deployment-props-builder builder id config)
The build-deployment-props-builder function updates a DeploymentProps$Builder instance using the provided configuration. The function takes the DeploymentProps$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 |
---|---|---|---|
api | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :api |
description | java.lang.String | cdk.support/lookup-entry | :description |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
The build-deployment-props-builder function updates a DeploymentProps$Builder instance using the provided configuration. The function takes the DeploymentProps$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 | |---|---|---|---| | `api` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:api` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` |
(build-domain-name-attributes-builder builder id config)
The build-domain-name-attributes-builder function updates a DomainNameAttributes$Builder instance using the provided configuration. The function takes the DomainNameAttributes$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 |
---|---|---|---|
domainName | java.lang.String | cdk.support/lookup-entry | :domain-name |
domainNameAliasHostedZoneId | java.lang.String | cdk.support/lookup-entry | :domain-name-alias-hosted-zone-id |
domainNameAliasTarget | java.lang.String | cdk.support/lookup-entry | :domain-name-alias-target |
The build-domain-name-attributes-builder function updates a DomainNameAttributes$Builder instance using the provided configuration. The function takes the DomainNameAttributes$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 | |---|---|---|---| | `domainName` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name` | | `domainNameAliasHostedZoneId` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name-alias-hosted-zone-id` | | `domainNameAliasTarget` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name-alias-target` |
(build-domain-name-builder builder id config)
The build-domain-name-builder function updates a DomainName$Builder instance using the provided configuration. The function takes the DomainName$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 |
---|---|---|---|
basePath | java.lang.String | cdk.support/lookup-entry | :base-path |
certificate | software.amazon.awscdk.services.certificatemanager.ICertificate | cdk.support/lookup-entry | :certificate |
domainName | java.lang.String | cdk.support/lookup-entry | :domain-name |
endpointType | software.amazon.awscdk.services.apigateway.EndpointType | cdk.api.services.apigateway/endpoint-type | :endpoint-type |
mapping | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :mapping |
mtls | software.amazon.awscdk.services.apigateway.MTLSConfig | cdk.support/lookup-entry | :mtls |
securityPolicy | software.amazon.awscdk.services.apigateway.SecurityPolicy | cdk.api.services.apigateway/security-policy | :security-policy |
The build-domain-name-builder function updates a DomainName$Builder instance using the provided configuration. The function takes the DomainName$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 | |---|---|---|---| | `basePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-path` | | `certificate` | software.amazon.awscdk.services.certificatemanager.ICertificate | [[cdk.support/lookup-entry]] | `:certificate` | | `domainName` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointType` | software.amazon.awscdk.services.apigateway.EndpointType | [[cdk.api.services.apigateway/endpoint-type]] | `:endpoint-type` | | `mapping` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:mapping` | | `mtls` | software.amazon.awscdk.services.apigateway.MTLSConfig | [[cdk.support/lookup-entry]] | `:mtls` | | `securityPolicy` | software.amazon.awscdk.services.apigateway.SecurityPolicy | [[cdk.api.services.apigateway/security-policy]] | `:security-policy` |
(build-domain-name-options-builder builder id config)
The build-domain-name-options-builder function updates a DomainNameOptions$Builder instance using the provided configuration. The function takes the DomainNameOptions$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 |
---|---|---|---|
basePath | java.lang.String | cdk.support/lookup-entry | :base-path |
certificate | software.amazon.awscdk.services.certificatemanager.ICertificate | cdk.support/lookup-entry | :certificate |
domainName | java.lang.String | cdk.support/lookup-entry | :domain-name |
endpointType | software.amazon.awscdk.services.apigateway.EndpointType | cdk.api.services.apigateway/endpoint-type | :endpoint-type |
mtls | software.amazon.awscdk.services.apigateway.MTLSConfig | cdk.support/lookup-entry | :mtls |
securityPolicy | software.amazon.awscdk.services.apigateway.SecurityPolicy | cdk.api.services.apigateway/security-policy | :security-policy |
The build-domain-name-options-builder function updates a DomainNameOptions$Builder instance using the provided configuration. The function takes the DomainNameOptions$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 | |---|---|---|---| | `basePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-path` | | `certificate` | software.amazon.awscdk.services.certificatemanager.ICertificate | [[cdk.support/lookup-entry]] | `:certificate` | | `domainName` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointType` | software.amazon.awscdk.services.apigateway.EndpointType | [[cdk.api.services.apigateway/endpoint-type]] | `:endpoint-type` | | `mtls` | software.amazon.awscdk.services.apigateway.MTLSConfig | [[cdk.support/lookup-entry]] | `:mtls` | | `securityPolicy` | software.amazon.awscdk.services.apigateway.SecurityPolicy | [[cdk.api.services.apigateway/security-policy]] | `:security-policy` |
(build-domain-name-props-builder builder id config)
The build-domain-name-props-builder function updates a DomainNameProps$Builder instance using the provided configuration. The function takes the DomainNameProps$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 |
---|---|---|---|
basePath | java.lang.String | cdk.support/lookup-entry | :base-path |
certificate | software.amazon.awscdk.services.certificatemanager.ICertificate | cdk.support/lookup-entry | :certificate |
domainName | java.lang.String | cdk.support/lookup-entry | :domain-name |
endpointType | software.amazon.awscdk.services.apigateway.EndpointType | cdk.api.services.apigateway/endpoint-type | :endpoint-type |
mapping | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :mapping |
mtls | software.amazon.awscdk.services.apigateway.MTLSConfig | cdk.support/lookup-entry | :mtls |
securityPolicy | software.amazon.awscdk.services.apigateway.SecurityPolicy | cdk.api.services.apigateway/security-policy | :security-policy |
The build-domain-name-props-builder function updates a DomainNameProps$Builder instance using the provided configuration. The function takes the DomainNameProps$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 | |---|---|---|---| | `basePath` | java.lang.String | [[cdk.support/lookup-entry]] | `:base-path` | | `certificate` | software.amazon.awscdk.services.certificatemanager.ICertificate | [[cdk.support/lookup-entry]] | `:certificate` | | `domainName` | java.lang.String | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointType` | software.amazon.awscdk.services.apigateway.EndpointType | [[cdk.api.services.apigateway/endpoint-type]] | `:endpoint-type` | | `mapping` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:mapping` | | `mtls` | software.amazon.awscdk.services.apigateway.MTLSConfig | [[cdk.support/lookup-entry]] | `:mtls` | | `securityPolicy` | software.amazon.awscdk.services.apigateway.SecurityPolicy | [[cdk.api.services.apigateway/security-policy]] | `:security-policy` |
(build-endpoint-configuration-builder builder id config)
The build-endpoint-configuration-builder function updates a EndpointConfiguration$Builder instance using the provided configuration. The function takes the EndpointConfiguration$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 |
---|---|---|---|
types | java.util.List | cdk.support/lookup-entry | :types |
vpcEndpoints | java.util.List | cdk.support/lookup-entry | :vpc-endpoints |
The build-endpoint-configuration-builder function updates a EndpointConfiguration$Builder instance using the provided configuration. The function takes the EndpointConfiguration$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 | |---|---|---|---| | `types` | java.util.List | [[cdk.support/lookup-entry]] | `:types` | | `vpcEndpoints` | java.util.List | [[cdk.support/lookup-entry]] | `:vpc-endpoints` |
(build-gateway-response-builder builder id config)
The build-gateway-response-builder function updates a GatewayResponse$Builder instance using the provided configuration. The function takes the GatewayResponse$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 |
---|---|---|---|
responseHeaders | java.util.Map | cdk.support/lookup-entry | :response-headers |
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
templates | java.util.Map | cdk.support/lookup-entry | :templates |
type | software.amazon.awscdk.services.apigateway.ResponseType | cdk.support/lookup-entry | :type |
The build-gateway-response-builder function updates a GatewayResponse$Builder instance using the provided configuration. The function takes the GatewayResponse$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 | |---|---|---|---| | `responseHeaders` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-headers` | | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` | | `templates` | java.util.Map | [[cdk.support/lookup-entry]] | `:templates` | | `type` | software.amazon.awscdk.services.apigateway.ResponseType | [[cdk.support/lookup-entry]] | `:type` |
(build-gateway-response-options-builder builder id config)
The build-gateway-response-options-builder function updates a GatewayResponseOptions$Builder instance using the provided configuration. The function takes the GatewayResponseOptions$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 |
---|---|---|---|
responseHeaders | java.util.Map | cdk.support/lookup-entry | :response-headers |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
templates | java.util.Map | cdk.support/lookup-entry | :templates |
type | software.amazon.awscdk.services.apigateway.ResponseType | cdk.support/lookup-entry | :type |
The build-gateway-response-options-builder function updates a GatewayResponseOptions$Builder instance using the provided configuration. The function takes the GatewayResponseOptions$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 | |---|---|---|---| | `responseHeaders` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-headers` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` | | `templates` | java.util.Map | [[cdk.support/lookup-entry]] | `:templates` | | `type` | software.amazon.awscdk.services.apigateway.ResponseType | [[cdk.support/lookup-entry]] | `:type` |
(build-gateway-response-props-builder builder id config)
The build-gateway-response-props-builder function updates a GatewayResponseProps$Builder instance using the provided configuration. The function takes the GatewayResponseProps$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 |
---|---|---|---|
responseHeaders | java.util.Map | cdk.support/lookup-entry | :response-headers |
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
templates | java.util.Map | cdk.support/lookup-entry | :templates |
type | software.amazon.awscdk.services.apigateway.ResponseType | cdk.support/lookup-entry | :type |
The build-gateway-response-props-builder function updates a GatewayResponseProps$Builder instance using the provided configuration. The function takes the GatewayResponseProps$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 | |---|---|---|---| | `responseHeaders` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-headers` | | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` | | `templates` | java.util.Map | [[cdk.support/lookup-entry]] | `:templates` | | `type` | software.amazon.awscdk.services.apigateway.ResponseType | [[cdk.support/lookup-entry]] | `:type` |
(build-http-integration-builder builder id config)
The build-http-integration-builder function updates a HttpIntegration$Builder instance using the provided configuration. The function takes the HttpIntegration$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 |
---|---|---|---|
httpMethod | java.lang.String | cdk.support/lookup-entry | :http-method |
options | software.amazon.awscdk.services.apigateway.IntegrationOptions | cdk.support/lookup-entry | :options |
proxy | java.lang.Boolean | cdk.support/lookup-entry | :proxy |
The build-http-integration-builder function updates a HttpIntegration$Builder instance using the provided configuration. The function takes the HttpIntegration$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 | |---|---|---|---| | `httpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:http-method` | | `options` | software.amazon.awscdk.services.apigateway.IntegrationOptions | [[cdk.support/lookup-entry]] | `:options` | | `proxy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:proxy` |
(build-http-integration-props-builder builder id config)
The build-http-integration-props-builder function updates a HttpIntegrationProps$Builder instance using the provided configuration. The function takes the HttpIntegrationProps$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 |
---|---|---|---|
httpMethod | java.lang.String | cdk.support/lookup-entry | :http-method |
options | software.amazon.awscdk.services.apigateway.IntegrationOptions | cdk.support/lookup-entry | :options |
proxy | java.lang.Boolean | cdk.support/lookup-entry | :proxy |
The build-http-integration-props-builder function updates a HttpIntegrationProps$Builder instance using the provided configuration. The function takes the HttpIntegrationProps$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 | |---|---|---|---| | `httpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:http-method` | | `options` | software.amazon.awscdk.services.apigateway.IntegrationOptions | [[cdk.support/lookup-entry]] | `:options` | | `proxy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:proxy` |
(build-integration-builder builder id config)
The build-integration-builder function updates a Integration$Builder instance using the provided configuration. The function takes the Integration$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 |
---|---|---|---|
integrationHttpMethod | java.lang.String | cdk.support/lookup-entry | :integration-http-method |
options | software.amazon.awscdk.services.apigateway.IntegrationOptions | cdk.support/lookup-entry | :options |
type | software.amazon.awscdk.services.apigateway.IntegrationType | cdk.api.services.apigateway/integration-type | :type |
uri | java.lang.Object | cdk.support/lookup-entry | :uri |
The build-integration-builder function updates a Integration$Builder instance using the provided configuration. The function takes the Integration$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 | |---|---|---|---| | `integrationHttpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:integration-http-method` | | `options` | software.amazon.awscdk.services.apigateway.IntegrationOptions | [[cdk.support/lookup-entry]] | `:options` | | `type` | software.amazon.awscdk.services.apigateway.IntegrationType | [[cdk.api.services.apigateway/integration-type]] | `:type` | | `uri` | java.lang.Object | [[cdk.support/lookup-entry]] | `:uri` |
(build-integration-config-builder builder id config)
The build-integration-config-builder function updates a IntegrationConfig$Builder instance using the provided configuration. The function takes the IntegrationConfig$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 |
---|---|---|---|
deploymentToken | java.lang.String | cdk.support/lookup-entry | :deployment-token |
integrationHttpMethod | java.lang.String | cdk.support/lookup-entry | :integration-http-method |
options | software.amazon.awscdk.services.apigateway.IntegrationOptions | cdk.support/lookup-entry | :options |
type | software.amazon.awscdk.services.apigateway.IntegrationType | cdk.api.services.apigateway/integration-type | :type |
uri | java.lang.String | cdk.support/lookup-entry | :uri |
The build-integration-config-builder function updates a IntegrationConfig$Builder instance using the provided configuration. The function takes the IntegrationConfig$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 | |---|---|---|---| | `deploymentToken` | java.lang.String | [[cdk.support/lookup-entry]] | `:deployment-token` | | `integrationHttpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:integration-http-method` | | `options` | software.amazon.awscdk.services.apigateway.IntegrationOptions | [[cdk.support/lookup-entry]] | `:options` | | `type` | software.amazon.awscdk.services.apigateway.IntegrationType | [[cdk.api.services.apigateway/integration-type]] | `:type` | | `uri` | java.lang.String | [[cdk.support/lookup-entry]] | `:uri` |
(build-integration-options-builder builder id config)
The build-integration-options-builder function updates a IntegrationOptions$Builder instance using the provided configuration. The function takes the IntegrationOptions$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 |
---|---|---|---|
cacheKeyParameters | java.util.List | cdk.support/lookup-entry | :cache-key-parameters |
cacheNamespace | java.lang.String | cdk.support/lookup-entry | :cache-namespace |
connectionType | software.amazon.awscdk.services.apigateway.ConnectionType | cdk.api.services.apigateway/connection-type | :connection-type |
contentHandling | software.amazon.awscdk.services.apigateway.ContentHandling | cdk.api.services.apigateway/content-handling | :content-handling |
credentialsPassthrough | java.lang.Boolean | cdk.support/lookup-entry | :credentials-passthrough |
credentialsRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :credentials-role |
integrationResponses | java.util.List | cdk.support/lookup-entry | :integration-responses |
passthroughBehavior | software.amazon.awscdk.services.apigateway.PassthroughBehavior | cdk.api.services.apigateway/passthrough-behavior | :passthrough-behavior |
requestParameters | java.util.Map | cdk.support/lookup-entry | :request-parameters |
requestTemplates | java.util.Map | cdk.support/lookup-entry | :request-templates |
timeout | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :timeout |
vpcLink | software.amazon.awscdk.services.apigateway.IVpcLink | cdk.support/lookup-entry | :vpc-link |
The build-integration-options-builder function updates a IntegrationOptions$Builder instance using the provided configuration. The function takes the IntegrationOptions$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 | |---|---|---|---| | `cacheKeyParameters` | java.util.List | [[cdk.support/lookup-entry]] | `:cache-key-parameters` | | `cacheNamespace` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-namespace` | | `connectionType` | software.amazon.awscdk.services.apigateway.ConnectionType | [[cdk.api.services.apigateway/connection-type]] | `:connection-type` | | `contentHandling` | software.amazon.awscdk.services.apigateway.ContentHandling | [[cdk.api.services.apigateway/content-handling]] | `:content-handling` | | `credentialsPassthrough` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:credentials-passthrough` | | `credentialsRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:credentials-role` | | `integrationResponses` | java.util.List | [[cdk.support/lookup-entry]] | `:integration-responses` | | `passthroughBehavior` | software.amazon.awscdk.services.apigateway.PassthroughBehavior | [[cdk.api.services.apigateway/passthrough-behavior]] | `:passthrough-behavior` | | `requestParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-templates` | | `timeout` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:timeout` | | `vpcLink` | software.amazon.awscdk.services.apigateway.IVpcLink | [[cdk.support/lookup-entry]] | `:vpc-link` |
(build-integration-props-builder builder id config)
The build-integration-props-builder function updates a IntegrationProps$Builder instance using the provided configuration. The function takes the IntegrationProps$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 |
---|---|---|---|
integrationHttpMethod | java.lang.String | cdk.support/lookup-entry | :integration-http-method |
options | software.amazon.awscdk.services.apigateway.IntegrationOptions | cdk.support/lookup-entry | :options |
type | software.amazon.awscdk.services.apigateway.IntegrationType | cdk.api.services.apigateway/integration-type | :type |
uri | java.lang.Object | cdk.support/lookup-entry | :uri |
The build-integration-props-builder function updates a IntegrationProps$Builder instance using the provided configuration. The function takes the IntegrationProps$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 | |---|---|---|---| | `integrationHttpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:integration-http-method` | | `options` | software.amazon.awscdk.services.apigateway.IntegrationOptions | [[cdk.support/lookup-entry]] | `:options` | | `type` | software.amazon.awscdk.services.apigateway.IntegrationType | [[cdk.api.services.apigateway/integration-type]] | `:type` | | `uri` | java.lang.Object | [[cdk.support/lookup-entry]] | `:uri` |
(build-integration-response-builder builder id config)
The build-integration-response-builder function updates a IntegrationResponse$Builder instance using the provided configuration. The function takes the IntegrationResponse$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 |
---|---|---|---|
contentHandling | software.amazon.awscdk.services.apigateway.ContentHandling | cdk.api.services.apigateway/content-handling | :content-handling |
responseParameters | java.util.Map | cdk.support/lookup-entry | :response-parameters |
responseTemplates | java.util.Map | cdk.support/lookup-entry | :response-templates |
selectionPattern | java.lang.String | cdk.support/lookup-entry | :selection-pattern |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
The build-integration-response-builder function updates a IntegrationResponse$Builder instance using the provided configuration. The function takes the IntegrationResponse$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 | |---|---|---|---| | `contentHandling` | software.amazon.awscdk.services.apigateway.ContentHandling | [[cdk.api.services.apigateway/content-handling]] | `:content-handling` | | `responseParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-parameters` | | `responseTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-templates` | | `selectionPattern` | java.lang.String | [[cdk.support/lookup-entry]] | `:selection-pattern` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` |
(build-json-schema-builder builder id config)
The build-json-schema-builder function updates a JsonSchema$Builder instance using the provided configuration. The function takes the JsonSchema$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 |
---|---|---|---|
additionalItems | java.util.List | cdk.support/lookup-entry | :additional-items |
additionalProperties | java.lang.Boolean | cdk.support/lookup-entry | :additional-properties |
allOf | java.util.List | cdk.support/lookup-entry | :all-of |
anyOf | java.util.List | cdk.support/lookup-entry | :any-of |
contains | java.util.List | cdk.support/lookup-entry | :contains |
defaultValue | java.lang.Object | cdk.support/lookup-entry | :default-value |
definitions | java.util.Map | cdk.support/lookup-entry | :definitions |
dependencies | java.util.Map | cdk.support/lookup-entry | :dependencies |
description | java.lang.String | cdk.support/lookup-entry | :description |
enumValue | java.util.List | cdk.support/lookup-entry | :enum-value |
exclusiveMaximum | java.lang.Boolean | cdk.support/lookup-entry | :exclusive-maximum |
exclusiveMinimum | java.lang.Boolean | cdk.support/lookup-entry | :exclusive-minimum |
format | java.lang.String | cdk.support/lookup-entry | :format |
id | java.lang.String | cdk.support/lookup-entry | :id |
items | java.util.List | cdk.support/lookup-entry | :items |
maxItems | java.lang.Number | cdk.support/lookup-entry | :max-items |
maxLength | java.lang.Number | cdk.support/lookup-entry | :max-length |
maxProperties | java.lang.Number | cdk.support/lookup-entry | :max-properties |
maximum | java.lang.Number | cdk.support/lookup-entry | :maximum |
minItems | java.lang.Number | cdk.support/lookup-entry | :min-items |
minLength | java.lang.Number | cdk.support/lookup-entry | :min-length |
minProperties | java.lang.Number | cdk.support/lookup-entry | :min-properties |
minimum | java.lang.Number | cdk.support/lookup-entry | :minimum |
multipleOf | java.lang.Number | cdk.support/lookup-entry | :multiple-of |
not | software.amazon.awscdk.services.apigateway.JsonSchema | cdk.support/lookup-entry | :not |
oneOf | java.util.List | cdk.support/lookup-entry | :one-of |
pattern | java.lang.String | cdk.support/lookup-entry | :pattern |
patternProperties | java.util.Map | cdk.support/lookup-entry | :pattern-properties |
properties | java.util.Map | cdk.support/lookup-entry | :properties |
propertyNames | software.amazon.awscdk.services.apigateway.JsonSchema | cdk.support/lookup-entry | :property-names |
ref | java.lang.String | cdk.support/lookup-entry | :ref |
required | java.util.List | cdk.support/lookup-entry | :required |
schema | software.amazon.awscdk.services.apigateway.JsonSchemaVersion | cdk.api.services.apigateway/json-schema-version | :schema |
title | java.lang.String | cdk.support/lookup-entry | :title |
type | java.util.List | cdk.support/lookup-entry | :type |
uniqueItems | java.lang.Boolean | cdk.support/lookup-entry | :unique-items |
The build-json-schema-builder function updates a JsonSchema$Builder instance using the provided configuration. The function takes the JsonSchema$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 | |---|---|---|---| | `additionalItems` | java.util.List | [[cdk.support/lookup-entry]] | `:additional-items` | | `additionalProperties` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:additional-properties` | | `allOf` | java.util.List | [[cdk.support/lookup-entry]] | `:all-of` | | `anyOf` | java.util.List | [[cdk.support/lookup-entry]] | `:any-of` | | `contains` | java.util.List | [[cdk.support/lookup-entry]] | `:contains` | | `defaultValue` | java.lang.Object | [[cdk.support/lookup-entry]] | `:default-value` | | `definitions` | java.util.Map | [[cdk.support/lookup-entry]] | `:definitions` | | `dependencies` | java.util.Map | [[cdk.support/lookup-entry]] | `:dependencies` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enumValue` | java.util.List | [[cdk.support/lookup-entry]] | `:enum-value` | | `exclusiveMaximum` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:exclusive-maximum` | | `exclusiveMinimum` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:exclusive-minimum` | | `format` | java.lang.String | [[cdk.support/lookup-entry]] | `:format` | | `id` | java.lang.String | [[cdk.support/lookup-entry]] | `:id` | | `items` | java.util.List | [[cdk.support/lookup-entry]] | `:items` | | `maxItems` | java.lang.Number | [[cdk.support/lookup-entry]] | `:max-items` | | `maxLength` | java.lang.Number | [[cdk.support/lookup-entry]] | `:max-length` | | `maxProperties` | java.lang.Number | [[cdk.support/lookup-entry]] | `:max-properties` | | `maximum` | java.lang.Number | [[cdk.support/lookup-entry]] | `:maximum` | | `minItems` | java.lang.Number | [[cdk.support/lookup-entry]] | `:min-items` | | `minLength` | java.lang.Number | [[cdk.support/lookup-entry]] | `:min-length` | | `minProperties` | java.lang.Number | [[cdk.support/lookup-entry]] | `:min-properties` | | `minimum` | java.lang.Number | [[cdk.support/lookup-entry]] | `:minimum` | | `multipleOf` | java.lang.Number | [[cdk.support/lookup-entry]] | `:multiple-of` | | `not` | software.amazon.awscdk.services.apigateway.JsonSchema | [[cdk.support/lookup-entry]] | `:not` | | `oneOf` | java.util.List | [[cdk.support/lookup-entry]] | `:one-of` | | `pattern` | java.lang.String | [[cdk.support/lookup-entry]] | `:pattern` | | `patternProperties` | java.util.Map | [[cdk.support/lookup-entry]] | `:pattern-properties` | | `properties` | java.util.Map | [[cdk.support/lookup-entry]] | `:properties` | | `propertyNames` | software.amazon.awscdk.services.apigateway.JsonSchema | [[cdk.support/lookup-entry]] | `:property-names` | | `ref` | java.lang.String | [[cdk.support/lookup-entry]] | `:ref` | | `required` | java.util.List | [[cdk.support/lookup-entry]] | `:required` | | `schema` | software.amazon.awscdk.services.apigateway.JsonSchemaVersion | [[cdk.api.services.apigateway/json-schema-version]] | `:schema` | | `title` | java.lang.String | [[cdk.support/lookup-entry]] | `:title` | | `type` | java.util.List | [[cdk.support/lookup-entry]] | `:type` | | `uniqueItems` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:unique-items` |
(build-json-with-standard-field-props-builder builder id config)
The build-json-with-standard-field-props-builder function updates a JsonWithStandardFieldProps$Builder instance using the provided configuration. The function takes the JsonWithStandardFieldProps$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 |
---|---|---|---|
caller | java.lang.Boolean | cdk.support/lookup-entry | :caller |
httpMethod | java.lang.Boolean | cdk.support/lookup-entry | :http-method |
ip | java.lang.Boolean | cdk.support/lookup-entry | :ip |
protocol | java.lang.Boolean | cdk.support/lookup-entry | :protocol |
requestTime | java.lang.Boolean | cdk.support/lookup-entry | :request-time |
resourcePath | java.lang.Boolean | cdk.support/lookup-entry | :resource-path |
responseLength | java.lang.Boolean | cdk.support/lookup-entry | :response-length |
status | java.lang.Boolean | cdk.support/lookup-entry | :status |
user | java.lang.Boolean | cdk.support/lookup-entry | :user |
The build-json-with-standard-field-props-builder function updates a JsonWithStandardFieldProps$Builder instance using the provided configuration. The function takes the JsonWithStandardFieldProps$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 | |---|---|---|---| | `caller` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:caller` | | `httpMethod` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:http-method` | | `ip` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:ip` | | `protocol` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:protocol` | | `requestTime` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:request-time` | | `resourcePath` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:resource-path` | | `responseLength` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:response-length` | | `status` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:status` | | `user` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:user` |
(build-lambda-authorizer-props-builder builder id config)
The build-lambda-authorizer-props-builder function updates a LambdaAuthorizerProps$Builder instance using the provided configuration. The function takes the LambdaAuthorizerProps$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 |
---|---|---|---|
assumeRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :assume-role |
authorizerName | java.lang.String | cdk.support/lookup-entry | :authorizer-name |
handler | software.amazon.awscdk.services.lambda.IFunction | cdk.support/lookup-entry | :handler |
resultsCacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :results-cache-ttl |
The build-lambda-authorizer-props-builder function updates a LambdaAuthorizerProps$Builder instance using the provided configuration. The function takes the LambdaAuthorizerProps$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 | |---|---|---|---| | `assumeRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:assume-role` | | `authorizerName` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-name` | | `handler` | software.amazon.awscdk.services.lambda.IFunction | [[cdk.support/lookup-entry]] | `:handler` | | `resultsCacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:results-cache-ttl` |
(build-lambda-integration-builder builder id config)
The build-lambda-integration-builder function updates a LambdaIntegration$Builder instance using the provided configuration. The function takes the LambdaIntegration$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 |
---|---|---|---|
allowTestInvoke | java.lang.Boolean | cdk.support/lookup-entry | :allow-test-invoke |
cacheKeyParameters | java.util.List | cdk.support/lookup-entry | :cache-key-parameters |
cacheNamespace | java.lang.String | cdk.support/lookup-entry | :cache-namespace |
connectionType | software.amazon.awscdk.services.apigateway.ConnectionType | cdk.api.services.apigateway/connection-type | :connection-type |
contentHandling | software.amazon.awscdk.services.apigateway.ContentHandling | cdk.api.services.apigateway/content-handling | :content-handling |
credentialsPassthrough | java.lang.Boolean | cdk.support/lookup-entry | :credentials-passthrough |
credentialsRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :credentials-role |
integrationResponses | java.util.List | cdk.support/lookup-entry | :integration-responses |
passthroughBehavior | software.amazon.awscdk.services.apigateway.PassthroughBehavior | cdk.api.services.apigateway/passthrough-behavior | :passthrough-behavior |
proxy | java.lang.Boolean | cdk.support/lookup-entry | :proxy |
requestParameters | java.util.Map | cdk.support/lookup-entry | :request-parameters |
requestTemplates | java.util.Map | cdk.support/lookup-entry | :request-templates |
timeout | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :timeout |
vpcLink | software.amazon.awscdk.services.apigateway.IVpcLink | cdk.support/lookup-entry | :vpc-link |
The build-lambda-integration-builder function updates a LambdaIntegration$Builder instance using the provided configuration. The function takes the LambdaIntegration$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 | |---|---|---|---| | `allowTestInvoke` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:allow-test-invoke` | | `cacheKeyParameters` | java.util.List | [[cdk.support/lookup-entry]] | `:cache-key-parameters` | | `cacheNamespace` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-namespace` | | `connectionType` | software.amazon.awscdk.services.apigateway.ConnectionType | [[cdk.api.services.apigateway/connection-type]] | `:connection-type` | | `contentHandling` | software.amazon.awscdk.services.apigateway.ContentHandling | [[cdk.api.services.apigateway/content-handling]] | `:content-handling` | | `credentialsPassthrough` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:credentials-passthrough` | | `credentialsRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:credentials-role` | | `integrationResponses` | java.util.List | [[cdk.support/lookup-entry]] | `:integration-responses` | | `passthroughBehavior` | software.amazon.awscdk.services.apigateway.PassthroughBehavior | [[cdk.api.services.apigateway/passthrough-behavior]] | `:passthrough-behavior` | | `proxy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:proxy` | | `requestParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-templates` | | `timeout` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:timeout` | | `vpcLink` | software.amazon.awscdk.services.apigateway.IVpcLink | [[cdk.support/lookup-entry]] | `:vpc-link` |
(build-lambda-integration-options-builder builder id config)
The build-lambda-integration-options-builder function updates a LambdaIntegrationOptions$Builder instance using the provided configuration. The function takes the LambdaIntegrationOptions$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 |
---|---|---|---|
allowTestInvoke | java.lang.Boolean | cdk.support/lookup-entry | :allow-test-invoke |
cacheKeyParameters | java.util.List | cdk.support/lookup-entry | :cache-key-parameters |
cacheNamespace | java.lang.String | cdk.support/lookup-entry | :cache-namespace |
connectionType | software.amazon.awscdk.services.apigateway.ConnectionType | cdk.api.services.apigateway/connection-type | :connection-type |
contentHandling | software.amazon.awscdk.services.apigateway.ContentHandling | cdk.api.services.apigateway/content-handling | :content-handling |
credentialsPassthrough | java.lang.Boolean | cdk.support/lookup-entry | :credentials-passthrough |
credentialsRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :credentials-role |
integrationResponses | java.util.List | cdk.support/lookup-entry | :integration-responses |
passthroughBehavior | software.amazon.awscdk.services.apigateway.PassthroughBehavior | cdk.api.services.apigateway/passthrough-behavior | :passthrough-behavior |
proxy | java.lang.Boolean | cdk.support/lookup-entry | :proxy |
requestParameters | java.util.Map | cdk.support/lookup-entry | :request-parameters |
requestTemplates | java.util.Map | cdk.support/lookup-entry | :request-templates |
timeout | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :timeout |
vpcLink | software.amazon.awscdk.services.apigateway.IVpcLink | cdk.support/lookup-entry | :vpc-link |
The build-lambda-integration-options-builder function updates a LambdaIntegrationOptions$Builder instance using the provided configuration. The function takes the LambdaIntegrationOptions$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 | |---|---|---|---| | `allowTestInvoke` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:allow-test-invoke` | | `cacheKeyParameters` | java.util.List | [[cdk.support/lookup-entry]] | `:cache-key-parameters` | | `cacheNamespace` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-namespace` | | `connectionType` | software.amazon.awscdk.services.apigateway.ConnectionType | [[cdk.api.services.apigateway/connection-type]] | `:connection-type` | | `contentHandling` | software.amazon.awscdk.services.apigateway.ContentHandling | [[cdk.api.services.apigateway/content-handling]] | `:content-handling` | | `credentialsPassthrough` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:credentials-passthrough` | | `credentialsRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:credentials-role` | | `integrationResponses` | java.util.List | [[cdk.support/lookup-entry]] | `:integration-responses` | | `passthroughBehavior` | software.amazon.awscdk.services.apigateway.PassthroughBehavior | [[cdk.api.services.apigateway/passthrough-behavior]] | `:passthrough-behavior` | | `proxy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:proxy` | | `requestParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-templates` | | `timeout` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:timeout` | | `vpcLink` | software.amazon.awscdk.services.apigateway.IVpcLink | [[cdk.support/lookup-entry]] | `:vpc-link` |
(build-lambda-rest-api-builder builder id config)
The build-lambda-rest-api-builder function updates a LambdaRestApi$Builder instance using the provided configuration. The function takes the LambdaRestApi$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 |
---|---|---|---|
apiKeySourceType | software.amazon.awscdk.services.apigateway.ApiKeySourceType | cdk.api.services.apigateway/api-key-source-type | :api-key-source-type |
binaryMediaTypes | java.util.List | cdk.support/lookup-entry | :binary-media-types |
cloneFrom | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :clone-from |
cloudWatchRole | java.lang.Boolean | cdk.support/lookup-entry | :cloud-watch-role |
cloudWatchRoleRemovalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :cloud-watch-role-removal-policy |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
deploy | java.lang.Boolean | cdk.support/lookup-entry | :deploy |
deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | cdk.support/lookup-entry | :deploy-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | cdk.support/lookup-entry | :domain-name |
endpointConfiguration | software.amazon.awscdk.services.apigateway.EndpointConfiguration | cdk.support/lookup-entry | :endpoint-configuration |
endpointExportName | java.lang.String | cdk.support/lookup-entry | :endpoint-export-name |
endpointTypes | java.util.List | cdk.support/lookup-entry | :endpoint-types |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
handler | software.amazon.awscdk.services.lambda.IFunction | cdk.support/lookup-entry | :handler |
integrationOptions | software.amazon.awscdk.services.apigateway.LambdaIntegrationOptions | cdk.support/lookup-entry | :integration-options |
minCompressionSize | software.amazon.awscdk.Size | cdk.support/lookup-entry | :min-compression-size |
minimumCompressionSize | java.lang.Number | cdk.support/lookup-entry | :minimum-compression-size |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
proxy | java.lang.Boolean | cdk.support/lookup-entry | :proxy |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
The build-lambda-rest-api-builder function updates a LambdaRestApi$Builder instance using the provided configuration. The function takes the LambdaRestApi$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 | |---|---|---|---| | `apiKeySourceType` | software.amazon.awscdk.services.apigateway.ApiKeySourceType | [[cdk.api.services.apigateway/api-key-source-type]] | `:api-key-source-type` | | `binaryMediaTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:binary-media-types` | | `cloneFrom` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:clone-from` | | `cloudWatchRole` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cloud-watch-role` | | `cloudWatchRoleRemovalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:cloud-watch-role-removal-policy` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `deploy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy` | | `deployOptions` | software.amazon.awscdk.services.apigateway.StageOptions | [[cdk.support/lookup-entry]] | `:deploy-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `domainName` | software.amazon.awscdk.services.apigateway.DomainNameOptions | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointConfiguration` | software.amazon.awscdk.services.apigateway.EndpointConfiguration | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `endpointExportName` | java.lang.String | [[cdk.support/lookup-entry]] | `:endpoint-export-name` | | `endpointTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:endpoint-types` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `handler` | software.amazon.awscdk.services.lambda.IFunction | [[cdk.support/lookup-entry]] | `:handler` | | `integrationOptions` | software.amazon.awscdk.services.apigateway.LambdaIntegrationOptions | [[cdk.support/lookup-entry]] | `:integration-options` | | `minCompressionSize` | software.amazon.awscdk.Size | [[cdk.support/lookup-entry]] | `:min-compression-size` | | `minimumCompressionSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:minimum-compression-size` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `proxy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:proxy` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` |
(build-lambda-rest-api-props-builder builder id config)
The build-lambda-rest-api-props-builder function updates a LambdaRestApiProps$Builder instance using the provided configuration. The function takes the LambdaRestApiProps$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 |
---|---|---|---|
apiKeySourceType | software.amazon.awscdk.services.apigateway.ApiKeySourceType | cdk.api.services.apigateway/api-key-source-type | :api-key-source-type |
binaryMediaTypes | java.util.List | cdk.support/lookup-entry | :binary-media-types |
cloneFrom | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :clone-from |
cloudWatchRole | java.lang.Boolean | cdk.support/lookup-entry | :cloud-watch-role |
cloudWatchRoleRemovalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :cloud-watch-role-removal-policy |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
deploy | java.lang.Boolean | cdk.support/lookup-entry | :deploy |
deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | cdk.support/lookup-entry | :deploy-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | cdk.support/lookup-entry | :domain-name |
endpointConfiguration | software.amazon.awscdk.services.apigateway.EndpointConfiguration | cdk.support/lookup-entry | :endpoint-configuration |
endpointExportName | java.lang.String | cdk.support/lookup-entry | :endpoint-export-name |
endpointTypes | java.util.List | cdk.support/lookup-entry | :endpoint-types |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
handler | software.amazon.awscdk.services.lambda.IFunction | cdk.support/lookup-entry | :handler |
integrationOptions | software.amazon.awscdk.services.apigateway.LambdaIntegrationOptions | cdk.support/lookup-entry | :integration-options |
minCompressionSize | software.amazon.awscdk.Size | cdk.support/lookup-entry | :min-compression-size |
minimumCompressionSize | java.lang.Number | cdk.support/lookup-entry | :minimum-compression-size |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
proxy | java.lang.Boolean | cdk.support/lookup-entry | :proxy |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
The build-lambda-rest-api-props-builder function updates a LambdaRestApiProps$Builder instance using the provided configuration. The function takes the LambdaRestApiProps$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 | |---|---|---|---| | `apiKeySourceType` | software.amazon.awscdk.services.apigateway.ApiKeySourceType | [[cdk.api.services.apigateway/api-key-source-type]] | `:api-key-source-type` | | `binaryMediaTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:binary-media-types` | | `cloneFrom` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:clone-from` | | `cloudWatchRole` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cloud-watch-role` | | `cloudWatchRoleRemovalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:cloud-watch-role-removal-policy` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `deploy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy` | | `deployOptions` | software.amazon.awscdk.services.apigateway.StageOptions | [[cdk.support/lookup-entry]] | `:deploy-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `domainName` | software.amazon.awscdk.services.apigateway.DomainNameOptions | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointConfiguration` | software.amazon.awscdk.services.apigateway.EndpointConfiguration | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `endpointExportName` | java.lang.String | [[cdk.support/lookup-entry]] | `:endpoint-export-name` | | `endpointTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:endpoint-types` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `handler` | software.amazon.awscdk.services.lambda.IFunction | [[cdk.support/lookup-entry]] | `:handler` | | `integrationOptions` | software.amazon.awscdk.services.apigateway.LambdaIntegrationOptions | [[cdk.support/lookup-entry]] | `:integration-options` | | `minCompressionSize` | software.amazon.awscdk.Size | [[cdk.support/lookup-entry]] | `:min-compression-size` | | `minimumCompressionSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:minimum-compression-size` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `proxy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:proxy` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` |
(build-method-builder builder id config)
The build-method-builder function updates a Method$Builder instance using the provided configuration. The function takes the Method$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 |
---|---|---|---|
httpMethod | java.lang.String | cdk.support/lookup-entry | :http-method |
integration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :integration |
options | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :options |
resource | software.amazon.awscdk.services.apigateway.IResource | cdk.support/lookup-entry | :resource |
The build-method-builder function updates a Method$Builder instance using the provided configuration. The function takes the Method$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 | |---|---|---|---| | `httpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:http-method` | | `integration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:integration` | | `options` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:options` | | `resource` | software.amazon.awscdk.services.apigateway.IResource | [[cdk.support/lookup-entry]] | `:resource` |
(build-method-deployment-options-builder builder id config)
The build-method-deployment-options-builder function updates a MethodDeploymentOptions$Builder instance using the provided configuration. The function takes the MethodDeploymentOptions$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 |
---|---|---|---|
cacheDataEncrypted | java.lang.Boolean | cdk.support/lookup-entry | :cache-data-encrypted |
cacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :cache-ttl |
cachingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :caching-enabled |
dataTraceEnabled | java.lang.Boolean | cdk.support/lookup-entry | :data-trace-enabled |
loggingLevel | software.amazon.awscdk.services.apigateway.MethodLoggingLevel | cdk.api.services.apigateway/method-logging-level | :logging-level |
metricsEnabled | java.lang.Boolean | cdk.support/lookup-entry | :metrics-enabled |
throttlingBurstLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-burst-limit |
throttlingRateLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-rate-limit |
The build-method-deployment-options-builder function updates a MethodDeploymentOptions$Builder instance using the provided configuration. The function takes the MethodDeploymentOptions$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 | |---|---|---|---| | `cacheDataEncrypted` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-data-encrypted` | | `cacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:cache-ttl` | | `cachingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:caching-enabled` | | `dataTraceEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:data-trace-enabled` | | `loggingLevel` | software.amazon.awscdk.services.apigateway.MethodLoggingLevel | [[cdk.api.services.apigateway/method-logging-level]] | `:logging-level` | | `metricsEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:metrics-enabled` | | `throttlingBurstLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-burst-limit` | | `throttlingRateLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-rate-limit` |
(build-method-options-builder builder id config)
The build-method-options-builder function updates a MethodOptions$Builder instance using the provided configuration. The function takes the MethodOptions$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 |
---|---|---|---|
apiKeyRequired | java.lang.Boolean | cdk.support/lookup-entry | :api-key-required |
authorizationScopes | java.util.List | cdk.support/lookup-entry | :authorization-scopes |
authorizationType | software.amazon.awscdk.services.apigateway.AuthorizationType | cdk.api.services.apigateway/authorization-type | :authorization-type |
authorizer | software.amazon.awscdk.services.apigateway.IAuthorizer | cdk.support/lookup-entry | :authorizer |
methodResponses | java.util.List | cdk.support/lookup-entry | :method-responses |
operationName | java.lang.String | cdk.support/lookup-entry | :operation-name |
requestModels | java.util.Map | cdk.support/lookup-entry | :request-models |
requestParameters | java.util.Map | cdk.support/lookup-entry | :request-parameters |
requestValidator | software.amazon.awscdk.services.apigateway.IRequestValidator | cdk.support/lookup-entry | :request-validator |
requestValidatorOptions | software.amazon.awscdk.services.apigateway.RequestValidatorOptions | cdk.support/lookup-entry | :request-validator-options |
The build-method-options-builder function updates a MethodOptions$Builder instance using the provided configuration. The function takes the MethodOptions$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 | |---|---|---|---| | `apiKeyRequired` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:api-key-required` | | `authorizationScopes` | java.util.List | [[cdk.support/lookup-entry]] | `:authorization-scopes` | | `authorizationType` | software.amazon.awscdk.services.apigateway.AuthorizationType | [[cdk.api.services.apigateway/authorization-type]] | `:authorization-type` | | `authorizer` | software.amazon.awscdk.services.apigateway.IAuthorizer | [[cdk.support/lookup-entry]] | `:authorizer` | | `methodResponses` | java.util.List | [[cdk.support/lookup-entry]] | `:method-responses` | | `operationName` | java.lang.String | [[cdk.support/lookup-entry]] | `:operation-name` | | `requestModels` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-models` | | `requestParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestValidator` | software.amazon.awscdk.services.apigateway.IRequestValidator | [[cdk.support/lookup-entry]] | `:request-validator` | | `requestValidatorOptions` | software.amazon.awscdk.services.apigateway.RequestValidatorOptions | [[cdk.support/lookup-entry]] | `:request-validator-options` |
(build-method-props-builder builder id config)
The build-method-props-builder function updates a MethodProps$Builder instance using the provided configuration. The function takes the MethodProps$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 |
---|---|---|---|
httpMethod | java.lang.String | cdk.support/lookup-entry | :http-method |
integration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :integration |
options | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :options |
resource | software.amazon.awscdk.services.apigateway.IResource | cdk.support/lookup-entry | :resource |
The build-method-props-builder function updates a MethodProps$Builder instance using the provided configuration. The function takes the MethodProps$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 | |---|---|---|---| | `httpMethod` | java.lang.String | [[cdk.support/lookup-entry]] | `:http-method` | | `integration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:integration` | | `options` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:options` | | `resource` | software.amazon.awscdk.services.apigateway.IResource | [[cdk.support/lookup-entry]] | `:resource` |
(build-method-response-builder builder id config)
The build-method-response-builder function updates a MethodResponse$Builder instance using the provided configuration. The function takes the MethodResponse$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 |
---|---|---|---|
responseModels | java.util.Map | cdk.support/lookup-entry | :response-models |
responseParameters | java.util.Map | cdk.support/lookup-entry | :response-parameters |
statusCode | java.lang.String | cdk.support/lookup-entry | :status-code |
The build-method-response-builder function updates a MethodResponse$Builder instance using the provided configuration. The function takes the MethodResponse$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 | |---|---|---|---| | `responseModels` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-models` | | `responseParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:response-parameters` | | `statusCode` | java.lang.String | [[cdk.support/lookup-entry]] | `:status-code` |
(build-mock-integration-builder builder id config)
The build-mock-integration-builder function updates a MockIntegration$Builder instance using the provided configuration. The function takes the MockIntegration$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 |
---|---|---|---|
cacheKeyParameters | java.util.List | cdk.support/lookup-entry | :cache-key-parameters |
cacheNamespace | java.lang.String | cdk.support/lookup-entry | :cache-namespace |
connectionType | software.amazon.awscdk.services.apigateway.ConnectionType | cdk.api.services.apigateway/connection-type | :connection-type |
contentHandling | software.amazon.awscdk.services.apigateway.ContentHandling | cdk.api.services.apigateway/content-handling | :content-handling |
credentialsPassthrough | java.lang.Boolean | cdk.support/lookup-entry | :credentials-passthrough |
credentialsRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :credentials-role |
integrationResponses | java.util.List | cdk.support/lookup-entry | :integration-responses |
passthroughBehavior | software.amazon.awscdk.services.apigateway.PassthroughBehavior | cdk.api.services.apigateway/passthrough-behavior | :passthrough-behavior |
requestParameters | java.util.Map | cdk.support/lookup-entry | :request-parameters |
requestTemplates | java.util.Map | cdk.support/lookup-entry | :request-templates |
timeout | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :timeout |
vpcLink | software.amazon.awscdk.services.apigateway.IVpcLink | cdk.support/lookup-entry | :vpc-link |
The build-mock-integration-builder function updates a MockIntegration$Builder instance using the provided configuration. The function takes the MockIntegration$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 | |---|---|---|---| | `cacheKeyParameters` | java.util.List | [[cdk.support/lookup-entry]] | `:cache-key-parameters` | | `cacheNamespace` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-namespace` | | `connectionType` | software.amazon.awscdk.services.apigateway.ConnectionType | [[cdk.api.services.apigateway/connection-type]] | `:connection-type` | | `contentHandling` | software.amazon.awscdk.services.apigateway.ContentHandling | [[cdk.api.services.apigateway/content-handling]] | `:content-handling` | | `credentialsPassthrough` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:credentials-passthrough` | | `credentialsRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:credentials-role` | | `integrationResponses` | java.util.List | [[cdk.support/lookup-entry]] | `:integration-responses` | | `passthroughBehavior` | software.amazon.awscdk.services.apigateway.PassthroughBehavior | [[cdk.api.services.apigateway/passthrough-behavior]] | `:passthrough-behavior` | | `requestParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-templates` | | `timeout` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:timeout` | | `vpcLink` | software.amazon.awscdk.services.apigateway.IVpcLink | [[cdk.support/lookup-entry]] | `:vpc-link` |
(build-model-builder builder id config)
The build-model-builder function updates a Model$Builder instance using the provided configuration. The function takes the Model$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 |
---|---|---|---|
contentType | java.lang.String | cdk.support/lookup-entry | :content-type |
description | java.lang.String | cdk.support/lookup-entry | :description |
modelName | java.lang.String | cdk.support/lookup-entry | :model-name |
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
schema | software.amazon.awscdk.services.apigateway.JsonSchema | cdk.support/lookup-entry | :schema |
The build-model-builder function updates a Model$Builder instance using the provided configuration. The function takes the Model$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 | |---|---|---|---| | `contentType` | java.lang.String | [[cdk.support/lookup-entry]] | `:content-type` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `modelName` | java.lang.String | [[cdk.support/lookup-entry]] | `:model-name` | | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` | | `schema` | software.amazon.awscdk.services.apigateway.JsonSchema | [[cdk.support/lookup-entry]] | `:schema` |
(build-model-options-builder builder id config)
The build-model-options-builder function updates a ModelOptions$Builder instance using the provided configuration. The function takes the ModelOptions$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 |
---|---|---|---|
contentType | java.lang.String | cdk.support/lookup-entry | :content-type |
description | java.lang.String | cdk.support/lookup-entry | :description |
modelName | java.lang.String | cdk.support/lookup-entry | :model-name |
schema | software.amazon.awscdk.services.apigateway.JsonSchema | cdk.support/lookup-entry | :schema |
The build-model-options-builder function updates a ModelOptions$Builder instance using the provided configuration. The function takes the ModelOptions$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 | |---|---|---|---| | `contentType` | java.lang.String | [[cdk.support/lookup-entry]] | `:content-type` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `modelName` | java.lang.String | [[cdk.support/lookup-entry]] | `:model-name` | | `schema` | software.amazon.awscdk.services.apigateway.JsonSchema | [[cdk.support/lookup-entry]] | `:schema` |
(build-model-props-builder builder id config)
The build-model-props-builder function updates a ModelProps$Builder instance using the provided configuration. The function takes the ModelProps$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 |
---|---|---|---|
contentType | java.lang.String | cdk.support/lookup-entry | :content-type |
description | java.lang.String | cdk.support/lookup-entry | :description |
modelName | java.lang.String | cdk.support/lookup-entry | :model-name |
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
schema | software.amazon.awscdk.services.apigateway.JsonSchema | cdk.support/lookup-entry | :schema |
The build-model-props-builder function updates a ModelProps$Builder instance using the provided configuration. The function takes the ModelProps$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 | |---|---|---|---| | `contentType` | java.lang.String | [[cdk.support/lookup-entry]] | `:content-type` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `modelName` | java.lang.String | [[cdk.support/lookup-entry]] | `:model-name` | | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` | | `schema` | software.amazon.awscdk.services.apigateway.JsonSchema | [[cdk.support/lookup-entry]] | `:schema` |
(build-mtls-config-builder builder id config)
The build-mtls-config-builder function updates a MTLSConfig$Builder instance using the provided configuration. The function takes the MTLSConfig$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 |
key | java.lang.String | cdk.support/lookup-entry | :key |
version | java.lang.String | cdk.support/lookup-entry | :version |
The build-mtls-config-builder function updates a MTLSConfig$Builder instance using the provided configuration. The function takes the MTLSConfig$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` | | `key` | java.lang.String | [[cdk.support/lookup-entry]] | `:key` | | `version` | java.lang.String | [[cdk.support/lookup-entry]] | `:version` |
(build-proxy-resource-builder builder id config)
The build-proxy-resource-builder function updates a ProxyResource$Builder instance using the provided configuration. The function takes the ProxyResource$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 |
---|---|---|---|
anyMethod | java.lang.Boolean | cdk.support/lookup-entry | :any-method |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
parent | software.amazon.awscdk.services.apigateway.IResource | cdk.support/lookup-entry | :parent |
The build-proxy-resource-builder function updates a ProxyResource$Builder instance using the provided configuration. The function takes the ProxyResource$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 | |---|---|---|---| | `anyMethod` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:any-method` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `parent` | software.amazon.awscdk.services.apigateway.IResource | [[cdk.support/lookup-entry]] | `:parent` |
(build-proxy-resource-options-builder builder id config)
The build-proxy-resource-options-builder function updates a ProxyResourceOptions$Builder instance using the provided configuration. The function takes the ProxyResourceOptions$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 |
---|---|---|---|
anyMethod | java.lang.Boolean | cdk.support/lookup-entry | :any-method |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
The build-proxy-resource-options-builder function updates a ProxyResourceOptions$Builder instance using the provided configuration. The function takes the ProxyResourceOptions$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 | |---|---|---|---| | `anyMethod` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:any-method` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` |
(build-proxy-resource-props-builder builder id config)
The build-proxy-resource-props-builder function updates a ProxyResourceProps$Builder instance using the provided configuration. The function takes the ProxyResourceProps$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 |
---|---|---|---|
anyMethod | java.lang.Boolean | cdk.support/lookup-entry | :any-method |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
parent | software.amazon.awscdk.services.apigateway.IResource | cdk.support/lookup-entry | :parent |
The build-proxy-resource-props-builder function updates a ProxyResourceProps$Builder instance using the provided configuration. The function takes the ProxyResourceProps$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 | |---|---|---|---| | `anyMethod` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:any-method` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `parent` | software.amazon.awscdk.services.apigateway.IResource | [[cdk.support/lookup-entry]] | `:parent` |
(build-quota-settings-builder builder id config)
The build-quota-settings-builder function updates a QuotaSettings$Builder instance using the provided configuration. The function takes the QuotaSettings$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 |
---|---|---|---|
limit | java.lang.Number | cdk.support/lookup-entry | :limit |
offset | java.lang.Number | cdk.support/lookup-entry | :offset |
period | software.amazon.awscdk.services.apigateway.Period | cdk.api.services.apigateway/period | :period |
The build-quota-settings-builder function updates a QuotaSettings$Builder instance using the provided configuration. The function takes the QuotaSettings$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 | |---|---|---|---| | `limit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:limit` | | `offset` | java.lang.Number | [[cdk.support/lookup-entry]] | `:offset` | | `period` | software.amazon.awscdk.services.apigateway.Period | [[cdk.api.services.apigateway/period]] | `:period` |
(build-rate-limited-api-key-builder builder id config)
The build-rate-limited-api-key-builder function updates a RateLimitedApiKey$Builder instance using the provided configuration. The function takes the RateLimitedApiKey$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 |
---|---|---|---|
apiKeyName | java.lang.String | cdk.support/lookup-entry | :api-key-name |
apiStages | java.util.List | cdk.support/lookup-entry | :api-stages |
customerId | java.lang.String | cdk.support/lookup-entry | :customer-id |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
generateDistinctId | java.lang.Boolean | cdk.support/lookup-entry | :generate-distinct-id |
quota | software.amazon.awscdk.services.apigateway.QuotaSettings | cdk.support/lookup-entry | :quota |
resources | java.util.List | cdk.support/lookup-entry | :resources |
stages | java.util.List | cdk.support/lookup-entry | :stages |
throttle | software.amazon.awscdk.services.apigateway.ThrottleSettings | cdk.support/lookup-entry | :throttle |
value | java.lang.String | cdk.support/lookup-entry | :value |
The build-rate-limited-api-key-builder function updates a RateLimitedApiKey$Builder instance using the provided configuration. The function takes the RateLimitedApiKey$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 | |---|---|---|---| | `apiKeyName` | java.lang.String | [[cdk.support/lookup-entry]] | `:api-key-name` | | `apiStages` | java.util.List | [[cdk.support/lookup-entry]] | `:api-stages` | | `customerId` | java.lang.String | [[cdk.support/lookup-entry]] | `:customer-id` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `generateDistinctId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:generate-distinct-id` | | `quota` | software.amazon.awscdk.services.apigateway.QuotaSettings | [[cdk.support/lookup-entry]] | `:quota` | | `resources` | java.util.List | [[cdk.support/lookup-entry]] | `:resources` | | `stages` | java.util.List | [[cdk.support/lookup-entry]] | `:stages` | | `throttle` | software.amazon.awscdk.services.apigateway.ThrottleSettings | [[cdk.support/lookup-entry]] | `:throttle` | | `value` | java.lang.String | [[cdk.support/lookup-entry]] | `:value` |
(build-rate-limited-api-key-props-builder builder id config)
The build-rate-limited-api-key-props-builder function updates a RateLimitedApiKeyProps$Builder instance using the provided configuration. The function takes the RateLimitedApiKeyProps$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 |
---|---|---|---|
apiKeyName | java.lang.String | cdk.support/lookup-entry | :api-key-name |
apiStages | java.util.List | cdk.support/lookup-entry | :api-stages |
customerId | java.lang.String | cdk.support/lookup-entry | :customer-id |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
generateDistinctId | java.lang.Boolean | cdk.support/lookup-entry | :generate-distinct-id |
quota | software.amazon.awscdk.services.apigateway.QuotaSettings | cdk.support/lookup-entry | :quota |
resources | java.util.List | cdk.support/lookup-entry | :resources |
stages | java.util.List | cdk.support/lookup-entry | :stages |
throttle | software.amazon.awscdk.services.apigateway.ThrottleSettings | cdk.support/lookup-entry | :throttle |
value | java.lang.String | cdk.support/lookup-entry | :value |
The build-rate-limited-api-key-props-builder function updates a RateLimitedApiKeyProps$Builder instance using the provided configuration. The function takes the RateLimitedApiKeyProps$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 | |---|---|---|---| | `apiKeyName` | java.lang.String | [[cdk.support/lookup-entry]] | `:api-key-name` | | `apiStages` | java.util.List | [[cdk.support/lookup-entry]] | `:api-stages` | | `customerId` | java.lang.String | [[cdk.support/lookup-entry]] | `:customer-id` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `generateDistinctId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:generate-distinct-id` | | `quota` | software.amazon.awscdk.services.apigateway.QuotaSettings | [[cdk.support/lookup-entry]] | `:quota` | | `resources` | java.util.List | [[cdk.support/lookup-entry]] | `:resources` | | `stages` | java.util.List | [[cdk.support/lookup-entry]] | `:stages` | | `throttle` | software.amazon.awscdk.services.apigateway.ThrottleSettings | [[cdk.support/lookup-entry]] | `:throttle` | | `value` | java.lang.String | [[cdk.support/lookup-entry]] | `:value` |
(build-request-authorizer-builder builder id config)
The build-request-authorizer-builder function updates a RequestAuthorizer$Builder instance using the provided configuration. The function takes the RequestAuthorizer$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 |
---|---|---|---|
assumeRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :assume-role |
authorizerName | java.lang.String | cdk.support/lookup-entry | :authorizer-name |
handler | software.amazon.awscdk.services.lambda.IFunction | cdk.support/lookup-entry | :handler |
identitySources | java.util.List | cdk.support/lookup-entry | :identity-sources |
resultsCacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :results-cache-ttl |
The build-request-authorizer-builder function updates a RequestAuthorizer$Builder instance using the provided configuration. The function takes the RequestAuthorizer$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 | |---|---|---|---| | `assumeRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:assume-role` | | `authorizerName` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-name` | | `handler` | software.amazon.awscdk.services.lambda.IFunction | [[cdk.support/lookup-entry]] | `:handler` | | `identitySources` | java.util.List | [[cdk.support/lookup-entry]] | `:identity-sources` | | `resultsCacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:results-cache-ttl` |
(build-request-authorizer-props-builder builder id config)
The build-request-authorizer-props-builder function updates a RequestAuthorizerProps$Builder instance using the provided configuration. The function takes the RequestAuthorizerProps$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 |
---|---|---|---|
assumeRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :assume-role |
authorizerName | java.lang.String | cdk.support/lookup-entry | :authorizer-name |
handler | software.amazon.awscdk.services.lambda.IFunction | cdk.support/lookup-entry | :handler |
identitySources | java.util.List | cdk.support/lookup-entry | :identity-sources |
resultsCacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :results-cache-ttl |
The build-request-authorizer-props-builder function updates a RequestAuthorizerProps$Builder instance using the provided configuration. The function takes the RequestAuthorizerProps$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 | |---|---|---|---| | `assumeRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:assume-role` | | `authorizerName` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-name` | | `handler` | software.amazon.awscdk.services.lambda.IFunction | [[cdk.support/lookup-entry]] | `:handler` | | `identitySources` | java.util.List | [[cdk.support/lookup-entry]] | `:identity-sources` | | `resultsCacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:results-cache-ttl` |
(build-request-context-builder builder id config)
The build-request-context-builder function updates a RequestContext$Builder instance using the provided configuration. The function takes the RequestContext$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 |
---|---|---|---|
accountId | java.lang.Boolean | cdk.support/lookup-entry | :account-id |
apiId | java.lang.Boolean | cdk.support/lookup-entry | :api-id |
apiKey | java.lang.Boolean | cdk.support/lookup-entry | :api-key |
authorizerPrincipalId | java.lang.Boolean | cdk.support/lookup-entry | :authorizer-principal-id |
caller | java.lang.Boolean | cdk.support/lookup-entry | :caller |
cognitoAuthenticationProvider | java.lang.Boolean | cdk.support/lookup-entry | :cognito-authentication-provider |
cognitoAuthenticationType | java.lang.Boolean | cdk.support/lookup-entry | :cognito-authentication-type |
cognitoIdentityId | java.lang.Boolean | cdk.support/lookup-entry | :cognito-identity-id |
cognitoIdentityPoolId | java.lang.Boolean | cdk.support/lookup-entry | :cognito-identity-pool-id |
httpMethod | java.lang.Boolean | cdk.support/lookup-entry | :http-method |
requestId | java.lang.Boolean | cdk.support/lookup-entry | :request-id |
resourceId | java.lang.Boolean | cdk.support/lookup-entry | :resource-id |
resourcePath | java.lang.Boolean | cdk.support/lookup-entry | :resource-path |
sourceIp | java.lang.Boolean | cdk.support/lookup-entry | :source-ip |
stage | java.lang.Boolean | cdk.support/lookup-entry | :stage |
user | java.lang.Boolean | cdk.support/lookup-entry | :user |
userAgent | java.lang.Boolean | cdk.support/lookup-entry | :user-agent |
userArn | java.lang.Boolean | cdk.support/lookup-entry | :user-arn |
The build-request-context-builder function updates a RequestContext$Builder instance using the provided configuration. The function takes the RequestContext$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 | |---|---|---|---| | `accountId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:account-id` | | `apiId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:api-id` | | `apiKey` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:api-key` | | `authorizerPrincipalId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:authorizer-principal-id` | | `caller` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:caller` | | `cognitoAuthenticationProvider` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cognito-authentication-provider` | | `cognitoAuthenticationType` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cognito-authentication-type` | | `cognitoIdentityId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cognito-identity-id` | | `cognitoIdentityPoolId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cognito-identity-pool-id` | | `httpMethod` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:http-method` | | `requestId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:request-id` | | `resourceId` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:resource-id` | | `resourcePath` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:resource-path` | | `sourceIp` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:source-ip` | | `stage` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:stage` | | `user` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:user` | | `userAgent` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:user-agent` | | `userArn` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:user-arn` |
(build-request-validator-builder builder id config)
The build-request-validator-builder function updates a RequestValidator$Builder instance using the provided configuration. The function takes the RequestValidator$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 |
---|---|---|---|
requestValidatorName | java.lang.String | cdk.support/lookup-entry | :request-validator-name |
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
validateRequestBody | java.lang.Boolean | cdk.support/lookup-entry | :validate-request-body |
validateRequestParameters | java.lang.Boolean | cdk.support/lookup-entry | :validate-request-parameters |
The build-request-validator-builder function updates a RequestValidator$Builder instance using the provided configuration. The function takes the RequestValidator$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 | |---|---|---|---| | `requestValidatorName` | java.lang.String | [[cdk.support/lookup-entry]] | `:request-validator-name` | | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` | | `validateRequestBody` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:validate-request-body` | | `validateRequestParameters` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:validate-request-parameters` |
(build-request-validator-options-builder builder id config)
The build-request-validator-options-builder function updates a RequestValidatorOptions$Builder instance using the provided configuration. The function takes the RequestValidatorOptions$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 |
---|---|---|---|
requestValidatorName | java.lang.String | cdk.support/lookup-entry | :request-validator-name |
validateRequestBody | java.lang.Boolean | cdk.support/lookup-entry | :validate-request-body |
validateRequestParameters | java.lang.Boolean | cdk.support/lookup-entry | :validate-request-parameters |
The build-request-validator-options-builder function updates a RequestValidatorOptions$Builder instance using the provided configuration. The function takes the RequestValidatorOptions$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 | |---|---|---|---| | `requestValidatorName` | java.lang.String | [[cdk.support/lookup-entry]] | `:request-validator-name` | | `validateRequestBody` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:validate-request-body` | | `validateRequestParameters` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:validate-request-parameters` |
(build-request-validator-props-builder builder id config)
The build-request-validator-props-builder function updates a RequestValidatorProps$Builder instance using the provided configuration. The function takes the RequestValidatorProps$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 |
---|---|---|---|
requestValidatorName | java.lang.String | cdk.support/lookup-entry | :request-validator-name |
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
validateRequestBody | java.lang.Boolean | cdk.support/lookup-entry | :validate-request-body |
validateRequestParameters | java.lang.Boolean | cdk.support/lookup-entry | :validate-request-parameters |
The build-request-validator-props-builder function updates a RequestValidatorProps$Builder instance using the provided configuration. The function takes the RequestValidatorProps$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 | |---|---|---|---| | `requestValidatorName` | java.lang.String | [[cdk.support/lookup-entry]] | `:request-validator-name` | | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` | | `validateRequestBody` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:validate-request-body` | | `validateRequestParameters` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:validate-request-parameters` |
(build-resource-attributes-builder builder id config)
The build-resource-attributes-builder function updates a ResourceAttributes$Builder instance using the provided configuration. The function takes the ResourceAttributes$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 |
---|---|---|---|
path | java.lang.String | cdk.support/lookup-entry | :path |
resourceId | java.lang.String | cdk.support/lookup-entry | :resource-id |
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
The build-resource-attributes-builder function updates a ResourceAttributes$Builder instance using the provided configuration. The function takes the ResourceAttributes$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 | |---|---|---|---| | `path` | java.lang.String | [[cdk.support/lookup-entry]] | `:path` | | `resourceId` | java.lang.String | [[cdk.support/lookup-entry]] | `:resource-id` | | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` |
(build-resource-builder builder id config)
The build-resource-builder function updates a Resource$Builder instance using the provided configuration. The function takes the Resource$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 |
---|---|---|---|
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
parent | software.amazon.awscdk.services.apigateway.IResource | cdk.support/lookup-entry | :parent |
pathPart | java.lang.String | cdk.support/lookup-entry | :path-part |
The build-resource-builder function updates a Resource$Builder instance using the provided configuration. The function takes the Resource$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 | |---|---|---|---| | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `parent` | software.amazon.awscdk.services.apigateway.IResource | [[cdk.support/lookup-entry]] | `:parent` | | `pathPart` | java.lang.String | [[cdk.support/lookup-entry]] | `:path-part` |
(build-resource-options-builder builder id config)
The build-resource-options-builder function updates a ResourceOptions$Builder instance using the provided configuration. The function takes the ResourceOptions$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 |
---|---|---|---|
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
The build-resource-options-builder function updates a ResourceOptions$Builder instance using the provided configuration. The function takes the ResourceOptions$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 | |---|---|---|---| | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` |
(build-resource-props-builder builder id config)
The build-resource-props-builder function updates a ResourceProps$Builder instance using the provided configuration. The function takes the ResourceProps$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 |
---|---|---|---|
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
parent | software.amazon.awscdk.services.apigateway.IResource | cdk.support/lookup-entry | :parent |
pathPart | java.lang.String | cdk.support/lookup-entry | :path-part |
The build-resource-props-builder function updates a ResourceProps$Builder instance using the provided configuration. The function takes the ResourceProps$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 | |---|---|---|---| | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `parent` | software.amazon.awscdk.services.apigateway.IResource | [[cdk.support/lookup-entry]] | `:parent` | | `pathPart` | java.lang.String | [[cdk.support/lookup-entry]] | `:path-part` |
(build-rest-api-attributes-builder builder id config)
The build-rest-api-attributes-builder function updates a RestApiAttributes$Builder instance using the provided configuration. The function takes the RestApiAttributes$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 |
---|---|---|---|
restApiId | java.lang.String | cdk.support/lookup-entry | :rest-api-id |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
rootResourceId | java.lang.String | cdk.support/lookup-entry | :root-resource-id |
The build-rest-api-attributes-builder function updates a RestApiAttributes$Builder instance using the provided configuration. The function takes the RestApiAttributes$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 | |---|---|---|---| | `restApiId` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-id` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `rootResourceId` | java.lang.String | [[cdk.support/lookup-entry]] | `:root-resource-id` |
(build-rest-api-base-props-builder builder id config)
The build-rest-api-base-props-builder function updates a RestApiBaseProps$Builder instance using the provided configuration. The function takes the RestApiBaseProps$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 |
---|---|---|---|
cloudWatchRole | java.lang.Boolean | cdk.support/lookup-entry | :cloud-watch-role |
cloudWatchRoleRemovalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :cloud-watch-role-removal-policy |
deploy | java.lang.Boolean | cdk.support/lookup-entry | :deploy |
deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | cdk.support/lookup-entry | :deploy-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | cdk.support/lookup-entry | :domain-name |
endpointExportName | java.lang.String | cdk.support/lookup-entry | :endpoint-export-name |
endpointTypes | java.util.List | cdk.support/lookup-entry | :endpoint-types |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
The build-rest-api-base-props-builder function updates a RestApiBaseProps$Builder instance using the provided configuration. The function takes the RestApiBaseProps$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 | |---|---|---|---| | `cloudWatchRole` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cloud-watch-role` | | `cloudWatchRoleRemovalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:cloud-watch-role-removal-policy` | | `deploy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy` | | `deployOptions` | software.amazon.awscdk.services.apigateway.StageOptions | [[cdk.support/lookup-entry]] | `:deploy-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `domainName` | software.amazon.awscdk.services.apigateway.DomainNameOptions | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointExportName` | java.lang.String | [[cdk.support/lookup-entry]] | `:endpoint-export-name` | | `endpointTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:endpoint-types` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` |
(build-rest-api-builder builder id config)
The build-rest-api-builder function updates a RestApi$Builder instance using the provided configuration. The function takes the RestApi$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 |
---|---|---|---|
apiKeySourceType | software.amazon.awscdk.services.apigateway.ApiKeySourceType | cdk.api.services.apigateway/api-key-source-type | :api-key-source-type |
binaryMediaTypes | java.util.List | cdk.support/lookup-entry | :binary-media-types |
cloneFrom | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :clone-from |
cloudWatchRole | java.lang.Boolean | cdk.support/lookup-entry | :cloud-watch-role |
cloudWatchRoleRemovalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :cloud-watch-role-removal-policy |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
deploy | java.lang.Boolean | cdk.support/lookup-entry | :deploy |
deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | cdk.support/lookup-entry | :deploy-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | cdk.support/lookup-entry | :domain-name |
endpointConfiguration | software.amazon.awscdk.services.apigateway.EndpointConfiguration | cdk.support/lookup-entry | :endpoint-configuration |
endpointExportName | java.lang.String | cdk.support/lookup-entry | :endpoint-export-name |
endpointTypes | java.util.List | cdk.support/lookup-entry | :endpoint-types |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
minCompressionSize | software.amazon.awscdk.Size | cdk.support/lookup-entry | :min-compression-size |
minimumCompressionSize | java.lang.Number | cdk.support/lookup-entry | :minimum-compression-size |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
The build-rest-api-builder function updates a RestApi$Builder instance using the provided configuration. The function takes the RestApi$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 | |---|---|---|---| | `apiKeySourceType` | software.amazon.awscdk.services.apigateway.ApiKeySourceType | [[cdk.api.services.apigateway/api-key-source-type]] | `:api-key-source-type` | | `binaryMediaTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:binary-media-types` | | `cloneFrom` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:clone-from` | | `cloudWatchRole` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cloud-watch-role` | | `cloudWatchRoleRemovalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:cloud-watch-role-removal-policy` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `deploy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy` | | `deployOptions` | software.amazon.awscdk.services.apigateway.StageOptions | [[cdk.support/lookup-entry]] | `:deploy-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `domainName` | software.amazon.awscdk.services.apigateway.DomainNameOptions | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointConfiguration` | software.amazon.awscdk.services.apigateway.EndpointConfiguration | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `endpointExportName` | java.lang.String | [[cdk.support/lookup-entry]] | `:endpoint-export-name` | | `endpointTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:endpoint-types` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `minCompressionSize` | software.amazon.awscdk.Size | [[cdk.support/lookup-entry]] | `:min-compression-size` | | `minimumCompressionSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:minimum-compression-size` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` |
(build-rest-api-props-builder builder id config)
The build-rest-api-props-builder function updates a RestApiProps$Builder instance using the provided configuration. The function takes the RestApiProps$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 |
---|---|---|---|
apiKeySourceType | software.amazon.awscdk.services.apigateway.ApiKeySourceType | cdk.api.services.apigateway/api-key-source-type | :api-key-source-type |
binaryMediaTypes | java.util.List | cdk.support/lookup-entry | :binary-media-types |
cloneFrom | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :clone-from |
cloudWatchRole | java.lang.Boolean | cdk.support/lookup-entry | :cloud-watch-role |
cloudWatchRoleRemovalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :cloud-watch-role-removal-policy |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
deploy | java.lang.Boolean | cdk.support/lookup-entry | :deploy |
deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | cdk.support/lookup-entry | :deploy-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | cdk.support/lookup-entry | :domain-name |
endpointConfiguration | software.amazon.awscdk.services.apigateway.EndpointConfiguration | cdk.support/lookup-entry | :endpoint-configuration |
endpointExportName | java.lang.String | cdk.support/lookup-entry | :endpoint-export-name |
endpointTypes | java.util.List | cdk.support/lookup-entry | :endpoint-types |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
minCompressionSize | software.amazon.awscdk.Size | cdk.support/lookup-entry | :min-compression-size |
minimumCompressionSize | java.lang.Number | cdk.support/lookup-entry | :minimum-compression-size |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
The build-rest-api-props-builder function updates a RestApiProps$Builder instance using the provided configuration. The function takes the RestApiProps$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 | |---|---|---|---| | `apiKeySourceType` | software.amazon.awscdk.services.apigateway.ApiKeySourceType | [[cdk.api.services.apigateway/api-key-source-type]] | `:api-key-source-type` | | `binaryMediaTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:binary-media-types` | | `cloneFrom` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:clone-from` | | `cloudWatchRole` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cloud-watch-role` | | `cloudWatchRoleRemovalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:cloud-watch-role-removal-policy` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `deploy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy` | | `deployOptions` | software.amazon.awscdk.services.apigateway.StageOptions | [[cdk.support/lookup-entry]] | `:deploy-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `domainName` | software.amazon.awscdk.services.apigateway.DomainNameOptions | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointConfiguration` | software.amazon.awscdk.services.apigateway.EndpointConfiguration | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `endpointExportName` | java.lang.String | [[cdk.support/lookup-entry]] | `:endpoint-export-name` | | `endpointTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:endpoint-types` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `minCompressionSize` | software.amazon.awscdk.Size | [[cdk.support/lookup-entry]] | `:min-compression-size` | | `minimumCompressionSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:minimum-compression-size` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` |
(build-sagemaker-integration-builder builder id config)
The build-sagemaker-integration-builder function updates a SagemakerIntegration$Builder instance using the provided configuration. The function takes the SagemakerIntegration$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 |
---|---|---|---|
cacheKeyParameters | java.util.List | cdk.support/lookup-entry | :cache-key-parameters |
cacheNamespace | java.lang.String | cdk.support/lookup-entry | :cache-namespace |
connectionType | software.amazon.awscdk.services.apigateway.ConnectionType | cdk.api.services.apigateway/connection-type | :connection-type |
contentHandling | software.amazon.awscdk.services.apigateway.ContentHandling | cdk.api.services.apigateway/content-handling | :content-handling |
credentialsPassthrough | java.lang.Boolean | cdk.support/lookup-entry | :credentials-passthrough |
credentialsRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :credentials-role |
integrationResponses | java.util.List | cdk.support/lookup-entry | :integration-responses |
passthroughBehavior | software.amazon.awscdk.services.apigateway.PassthroughBehavior | cdk.api.services.apigateway/passthrough-behavior | :passthrough-behavior |
requestParameters | java.util.Map | cdk.support/lookup-entry | :request-parameters |
requestTemplates | java.util.Map | cdk.support/lookup-entry | :request-templates |
timeout | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :timeout |
vpcLink | software.amazon.awscdk.services.apigateway.IVpcLink | cdk.support/lookup-entry | :vpc-link |
The build-sagemaker-integration-builder function updates a SagemakerIntegration$Builder instance using the provided configuration. The function takes the SagemakerIntegration$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 | |---|---|---|---| | `cacheKeyParameters` | java.util.List | [[cdk.support/lookup-entry]] | `:cache-key-parameters` | | `cacheNamespace` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-namespace` | | `connectionType` | software.amazon.awscdk.services.apigateway.ConnectionType | [[cdk.api.services.apigateway/connection-type]] | `:connection-type` | | `contentHandling` | software.amazon.awscdk.services.apigateway.ContentHandling | [[cdk.api.services.apigateway/content-handling]] | `:content-handling` | | `credentialsPassthrough` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:credentials-passthrough` | | `credentialsRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:credentials-role` | | `integrationResponses` | java.util.List | [[cdk.support/lookup-entry]] | `:integration-responses` | | `passthroughBehavior` | software.amazon.awscdk.services.apigateway.PassthroughBehavior | [[cdk.api.services.apigateway/passthrough-behavior]] | `:passthrough-behavior` | | `requestParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-templates` | | `timeout` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:timeout` | | `vpcLink` | software.amazon.awscdk.services.apigateway.IVpcLink | [[cdk.support/lookup-entry]] | `:vpc-link` |
(build-sagemaker-integration-options-builder builder id config)
The build-sagemaker-integration-options-builder function updates a SagemakerIntegrationOptions$Builder instance using the provided configuration. The function takes the SagemakerIntegrationOptions$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 |
---|---|---|---|
cacheKeyParameters | java.util.List | cdk.support/lookup-entry | :cache-key-parameters |
cacheNamespace | java.lang.String | cdk.support/lookup-entry | :cache-namespace |
connectionType | software.amazon.awscdk.services.apigateway.ConnectionType | cdk.api.services.apigateway/connection-type | :connection-type |
contentHandling | software.amazon.awscdk.services.apigateway.ContentHandling | cdk.api.services.apigateway/content-handling | :content-handling |
credentialsPassthrough | java.lang.Boolean | cdk.support/lookup-entry | :credentials-passthrough |
credentialsRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :credentials-role |
integrationResponses | java.util.List | cdk.support/lookup-entry | :integration-responses |
passthroughBehavior | software.amazon.awscdk.services.apigateway.PassthroughBehavior | cdk.api.services.apigateway/passthrough-behavior | :passthrough-behavior |
requestParameters | java.util.Map | cdk.support/lookup-entry | :request-parameters |
requestTemplates | java.util.Map | cdk.support/lookup-entry | :request-templates |
timeout | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :timeout |
vpcLink | software.amazon.awscdk.services.apigateway.IVpcLink | cdk.support/lookup-entry | :vpc-link |
The build-sagemaker-integration-options-builder function updates a SagemakerIntegrationOptions$Builder instance using the provided configuration. The function takes the SagemakerIntegrationOptions$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 | |---|---|---|---| | `cacheKeyParameters` | java.util.List | [[cdk.support/lookup-entry]] | `:cache-key-parameters` | | `cacheNamespace` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-namespace` | | `connectionType` | software.amazon.awscdk.services.apigateway.ConnectionType | [[cdk.api.services.apigateway/connection-type]] | `:connection-type` | | `contentHandling` | software.amazon.awscdk.services.apigateway.ContentHandling | [[cdk.api.services.apigateway/content-handling]] | `:content-handling` | | `credentialsPassthrough` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:credentials-passthrough` | | `credentialsRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:credentials-role` | | `integrationResponses` | java.util.List | [[cdk.support/lookup-entry]] | `:integration-responses` | | `passthroughBehavior` | software.amazon.awscdk.services.apigateway.PassthroughBehavior | [[cdk.api.services.apigateway/passthrough-behavior]] | `:passthrough-behavior` | | `requestParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-templates` | | `timeout` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:timeout` | | `vpcLink` | software.amazon.awscdk.services.apigateway.IVpcLink | [[cdk.support/lookup-entry]] | `:vpc-link` |
(build-spec-rest-api-builder builder id config)
The build-spec-rest-api-builder function updates a SpecRestApi$Builder instance using the provided configuration. The function takes the SpecRestApi$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 |
---|---|---|---|
apiDefinition | software.amazon.awscdk.services.apigateway.ApiDefinition | cdk.support/lookup-entry | :api-definition |
cloudWatchRole | java.lang.Boolean | cdk.support/lookup-entry | :cloud-watch-role |
cloudWatchRoleRemovalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :cloud-watch-role-removal-policy |
deploy | java.lang.Boolean | cdk.support/lookup-entry | :deploy |
deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | cdk.support/lookup-entry | :deploy-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | cdk.support/lookup-entry | :domain-name |
endpointExportName | java.lang.String | cdk.support/lookup-entry | :endpoint-export-name |
endpointTypes | java.util.List | cdk.support/lookup-entry | :endpoint-types |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
minCompressionSize | software.amazon.awscdk.Size | cdk.support/lookup-entry | :min-compression-size |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
The build-spec-rest-api-builder function updates a SpecRestApi$Builder instance using the provided configuration. The function takes the SpecRestApi$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 | |---|---|---|---| | `apiDefinition` | software.amazon.awscdk.services.apigateway.ApiDefinition | [[cdk.support/lookup-entry]] | `:api-definition` | | `cloudWatchRole` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cloud-watch-role` | | `cloudWatchRoleRemovalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:cloud-watch-role-removal-policy` | | `deploy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy` | | `deployOptions` | software.amazon.awscdk.services.apigateway.StageOptions | [[cdk.support/lookup-entry]] | `:deploy-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `domainName` | software.amazon.awscdk.services.apigateway.DomainNameOptions | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointExportName` | java.lang.String | [[cdk.support/lookup-entry]] | `:endpoint-export-name` | | `endpointTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:endpoint-types` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `minCompressionSize` | software.amazon.awscdk.Size | [[cdk.support/lookup-entry]] | `:min-compression-size` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` |
(build-spec-rest-api-props-builder builder id config)
The build-spec-rest-api-props-builder function updates a SpecRestApiProps$Builder instance using the provided configuration. The function takes the SpecRestApiProps$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 |
---|---|---|---|
apiDefinition | software.amazon.awscdk.services.apigateway.ApiDefinition | cdk.support/lookup-entry | :api-definition |
cloudWatchRole | java.lang.Boolean | cdk.support/lookup-entry | :cloud-watch-role |
cloudWatchRoleRemovalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :cloud-watch-role-removal-policy |
deploy | java.lang.Boolean | cdk.support/lookup-entry | :deploy |
deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | cdk.support/lookup-entry | :deploy-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | cdk.support/lookup-entry | :domain-name |
endpointExportName | java.lang.String | cdk.support/lookup-entry | :endpoint-export-name |
endpointTypes | java.util.List | cdk.support/lookup-entry | :endpoint-types |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
minCompressionSize | software.amazon.awscdk.Size | cdk.support/lookup-entry | :min-compression-size |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
The build-spec-rest-api-props-builder function updates a SpecRestApiProps$Builder instance using the provided configuration. The function takes the SpecRestApiProps$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 | |---|---|---|---| | `apiDefinition` | software.amazon.awscdk.services.apigateway.ApiDefinition | [[cdk.support/lookup-entry]] | `:api-definition` | | `cloudWatchRole` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cloud-watch-role` | | `cloudWatchRoleRemovalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:cloud-watch-role-removal-policy` | | `deploy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy` | | `deployOptions` | software.amazon.awscdk.services.apigateway.StageOptions | [[cdk.support/lookup-entry]] | `:deploy-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `domainName` | software.amazon.awscdk.services.apigateway.DomainNameOptions | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointExportName` | java.lang.String | [[cdk.support/lookup-entry]] | `:endpoint-export-name` | | `endpointTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:endpoint-types` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `minCompressionSize` | software.amazon.awscdk.Size | [[cdk.support/lookup-entry]] | `:min-compression-size` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` |
(build-stage-attributes-builder builder id config)
The build-stage-attributes-builder function updates a StageAttributes$Builder instance using the provided configuration. The function takes the StageAttributes$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 |
---|---|---|---|
restApi | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :rest-api |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
The build-stage-attributes-builder function updates a StageAttributes$Builder instance using the provided configuration. The function takes the StageAttributes$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 | |---|---|---|---| | `restApi` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:rest-api` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` |
(build-stage-builder builder id config)
The build-stage-builder function updates a Stage$Builder instance using the provided configuration. The function takes the Stage$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 |
---|---|---|---|
accessLogDestination | software.amazon.awscdk.services.apigateway.IAccessLogDestination | cdk.support/lookup-entry | :access-log-destination |
accessLogFormat | software.amazon.awscdk.services.apigateway.AccessLogFormat | cdk.support/lookup-entry | :access-log-format |
cacheClusterEnabled | java.lang.Boolean | cdk.support/lookup-entry | :cache-cluster-enabled |
cacheClusterSize | java.lang.String | cdk.support/lookup-entry | :cache-cluster-size |
cacheDataEncrypted | java.lang.Boolean | cdk.support/lookup-entry | :cache-data-encrypted |
cacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :cache-ttl |
cachingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :caching-enabled |
clientCertificateId | java.lang.String | cdk.support/lookup-entry | :client-certificate-id |
dataTraceEnabled | java.lang.Boolean | cdk.support/lookup-entry | :data-trace-enabled |
deployment | software.amazon.awscdk.services.apigateway.Deployment | cdk.support/lookup-entry | :deployment |
description | java.lang.String | cdk.support/lookup-entry | :description |
documentationVersion | java.lang.String | cdk.support/lookup-entry | :documentation-version |
loggingLevel | software.amazon.awscdk.services.apigateway.MethodLoggingLevel | cdk.api.services.apigateway/method-logging-level | :logging-level |
methodOptions | java.util.Map | cdk.support/lookup-entry | :method-options |
metricsEnabled | java.lang.Boolean | cdk.support/lookup-entry | :metrics-enabled |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
throttlingBurstLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-burst-limit |
throttlingRateLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-rate-limit |
tracingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :tracing-enabled |
variables | java.util.Map | cdk.support/lookup-entry | :variables |
The build-stage-builder function updates a Stage$Builder instance using the provided configuration. The function takes the Stage$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 | |---|---|---|---| | `accessLogDestination` | software.amazon.awscdk.services.apigateway.IAccessLogDestination | [[cdk.support/lookup-entry]] | `:access-log-destination` | | `accessLogFormat` | software.amazon.awscdk.services.apigateway.AccessLogFormat | [[cdk.support/lookup-entry]] | `:access-log-format` | | `cacheClusterEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-cluster-enabled` | | `cacheClusterSize` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-cluster-size` | | `cacheDataEncrypted` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-data-encrypted` | | `cacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:cache-ttl` | | `cachingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:caching-enabled` | | `clientCertificateId` | java.lang.String | [[cdk.support/lookup-entry]] | `:client-certificate-id` | | `dataTraceEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:data-trace-enabled` | | `deployment` | software.amazon.awscdk.services.apigateway.Deployment | [[cdk.support/lookup-entry]] | `:deployment` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `documentationVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:documentation-version` | | `loggingLevel` | software.amazon.awscdk.services.apigateway.MethodLoggingLevel | [[cdk.api.services.apigateway/method-logging-level]] | `:logging-level` | | `methodOptions` | java.util.Map | [[cdk.support/lookup-entry]] | `:method-options` | | `metricsEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:metrics-enabled` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` | | `throttlingBurstLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-burst-limit` | | `throttlingRateLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-rate-limit` | | `tracingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:tracing-enabled` | | `variables` | java.util.Map | [[cdk.support/lookup-entry]] | `:variables` |
(build-stage-options-builder builder id config)
The build-stage-options-builder function updates a StageOptions$Builder instance using the provided configuration. The function takes the StageOptions$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 |
---|---|---|---|
accessLogDestination | software.amazon.awscdk.services.apigateway.IAccessLogDestination | cdk.support/lookup-entry | :access-log-destination |
accessLogFormat | software.amazon.awscdk.services.apigateway.AccessLogFormat | cdk.support/lookup-entry | :access-log-format |
cacheClusterEnabled | java.lang.Boolean | cdk.support/lookup-entry | :cache-cluster-enabled |
cacheClusterSize | java.lang.String | cdk.support/lookup-entry | :cache-cluster-size |
cacheDataEncrypted | java.lang.Boolean | cdk.support/lookup-entry | :cache-data-encrypted |
cacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :cache-ttl |
cachingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :caching-enabled |
clientCertificateId | java.lang.String | cdk.support/lookup-entry | :client-certificate-id |
dataTraceEnabled | java.lang.Boolean | cdk.support/lookup-entry | :data-trace-enabled |
description | java.lang.String | cdk.support/lookup-entry | :description |
documentationVersion | java.lang.String | cdk.support/lookup-entry | :documentation-version |
loggingLevel | software.amazon.awscdk.services.apigateway.MethodLoggingLevel | cdk.api.services.apigateway/method-logging-level | :logging-level |
methodOptions | java.util.Map | cdk.support/lookup-entry | :method-options |
metricsEnabled | java.lang.Boolean | cdk.support/lookup-entry | :metrics-enabled |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
throttlingBurstLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-burst-limit |
throttlingRateLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-rate-limit |
tracingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :tracing-enabled |
variables | java.util.Map | cdk.support/lookup-entry | :variables |
The build-stage-options-builder function updates a StageOptions$Builder instance using the provided configuration. The function takes the StageOptions$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 | |---|---|---|---| | `accessLogDestination` | software.amazon.awscdk.services.apigateway.IAccessLogDestination | [[cdk.support/lookup-entry]] | `:access-log-destination` | | `accessLogFormat` | software.amazon.awscdk.services.apigateway.AccessLogFormat | [[cdk.support/lookup-entry]] | `:access-log-format` | | `cacheClusterEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-cluster-enabled` | | `cacheClusterSize` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-cluster-size` | | `cacheDataEncrypted` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-data-encrypted` | | `cacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:cache-ttl` | | `cachingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:caching-enabled` | | `clientCertificateId` | java.lang.String | [[cdk.support/lookup-entry]] | `:client-certificate-id` | | `dataTraceEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:data-trace-enabled` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `documentationVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:documentation-version` | | `loggingLevel` | software.amazon.awscdk.services.apigateway.MethodLoggingLevel | [[cdk.api.services.apigateway/method-logging-level]] | `:logging-level` | | `methodOptions` | java.util.Map | [[cdk.support/lookup-entry]] | `:method-options` | | `metricsEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:metrics-enabled` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` | | `throttlingBurstLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-burst-limit` | | `throttlingRateLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-rate-limit` | | `tracingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:tracing-enabled` | | `variables` | java.util.Map | [[cdk.support/lookup-entry]] | `:variables` |
(build-stage-props-builder builder id config)
The build-stage-props-builder function updates a StageProps$Builder instance using the provided configuration. The function takes the StageProps$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 |
---|---|---|---|
accessLogDestination | software.amazon.awscdk.services.apigateway.IAccessLogDestination | cdk.support/lookup-entry | :access-log-destination |
accessLogFormat | software.amazon.awscdk.services.apigateway.AccessLogFormat | cdk.support/lookup-entry | :access-log-format |
cacheClusterEnabled | java.lang.Boolean | cdk.support/lookup-entry | :cache-cluster-enabled |
cacheClusterSize | java.lang.String | cdk.support/lookup-entry | :cache-cluster-size |
cacheDataEncrypted | java.lang.Boolean | cdk.support/lookup-entry | :cache-data-encrypted |
cacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :cache-ttl |
cachingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :caching-enabled |
clientCertificateId | java.lang.String | cdk.support/lookup-entry | :client-certificate-id |
dataTraceEnabled | java.lang.Boolean | cdk.support/lookup-entry | :data-trace-enabled |
deployment | software.amazon.awscdk.services.apigateway.Deployment | cdk.support/lookup-entry | :deployment |
description | java.lang.String | cdk.support/lookup-entry | :description |
documentationVersion | java.lang.String | cdk.support/lookup-entry | :documentation-version |
loggingLevel | software.amazon.awscdk.services.apigateway.MethodLoggingLevel | cdk.api.services.apigateway/method-logging-level | :logging-level |
methodOptions | java.util.Map | cdk.support/lookup-entry | :method-options |
metricsEnabled | java.lang.Boolean | cdk.support/lookup-entry | :metrics-enabled |
stageName | java.lang.String | cdk.support/lookup-entry | :stage-name |
throttlingBurstLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-burst-limit |
throttlingRateLimit | java.lang.Number | cdk.support/lookup-entry | :throttling-rate-limit |
tracingEnabled | java.lang.Boolean | cdk.support/lookup-entry | :tracing-enabled |
variables | java.util.Map | cdk.support/lookup-entry | :variables |
The build-stage-props-builder function updates a StageProps$Builder instance using the provided configuration. The function takes the StageProps$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 | |---|---|---|---| | `accessLogDestination` | software.amazon.awscdk.services.apigateway.IAccessLogDestination | [[cdk.support/lookup-entry]] | `:access-log-destination` | | `accessLogFormat` | software.amazon.awscdk.services.apigateway.AccessLogFormat | [[cdk.support/lookup-entry]] | `:access-log-format` | | `cacheClusterEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-cluster-enabled` | | `cacheClusterSize` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-cluster-size` | | `cacheDataEncrypted` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cache-data-encrypted` | | `cacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:cache-ttl` | | `cachingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:caching-enabled` | | `clientCertificateId` | java.lang.String | [[cdk.support/lookup-entry]] | `:client-certificate-id` | | `dataTraceEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:data-trace-enabled` | | `deployment` | software.amazon.awscdk.services.apigateway.Deployment | [[cdk.support/lookup-entry]] | `:deployment` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `documentationVersion` | java.lang.String | [[cdk.support/lookup-entry]] | `:documentation-version` | | `loggingLevel` | software.amazon.awscdk.services.apigateway.MethodLoggingLevel | [[cdk.api.services.apigateway/method-logging-level]] | `:logging-level` | | `methodOptions` | java.util.Map | [[cdk.support/lookup-entry]] | `:method-options` | | `metricsEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:metrics-enabled` | | `stageName` | java.lang.String | [[cdk.support/lookup-entry]] | `:stage-name` | | `throttlingBurstLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-burst-limit` | | `throttlingRateLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:throttling-rate-limit` | | `tracingEnabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:tracing-enabled` | | `variables` | java.util.Map | [[cdk.support/lookup-entry]] | `:variables` |
(build-step-functions-execution-integration-options-builder builder id config)
The build-step-functions-execution-integration-options-builder function updates a StepFunctionsExecutionIntegrationOptions$Builder instance using the provided configuration. The function takes the StepFunctionsExecutionIntegrationOptions$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 |
---|---|---|---|
authorizer | java.lang.Boolean | cdk.support/lookup-entry | :authorizer |
cacheKeyParameters | java.util.List | cdk.support/lookup-entry | :cache-key-parameters |
cacheNamespace | java.lang.String | cdk.support/lookup-entry | :cache-namespace |
connectionType | software.amazon.awscdk.services.apigateway.ConnectionType | cdk.api.services.apigateway/connection-type | :connection-type |
contentHandling | software.amazon.awscdk.services.apigateway.ContentHandling | cdk.api.services.apigateway/content-handling | :content-handling |
credentialsPassthrough | java.lang.Boolean | cdk.support/lookup-entry | :credentials-passthrough |
credentialsRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :credentials-role |
headers | java.lang.Boolean | cdk.support/lookup-entry | :headers |
integrationResponses | java.util.List | cdk.support/lookup-entry | :integration-responses |
passthroughBehavior | software.amazon.awscdk.services.apigateway.PassthroughBehavior | cdk.api.services.apigateway/passthrough-behavior | :passthrough-behavior |
path | java.lang.Boolean | cdk.support/lookup-entry | :path |
querystring | java.lang.Boolean | cdk.support/lookup-entry | :querystring |
requestContext | software.amazon.awscdk.services.apigateway.RequestContext | cdk.support/lookup-entry | :request-context |
requestParameters | java.util.Map | cdk.support/lookup-entry | :request-parameters |
requestTemplates | java.util.Map | cdk.support/lookup-entry | :request-templates |
timeout | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :timeout |
useDefaultMethodResponses | java.lang.Boolean | cdk.support/lookup-entry | :use-default-method-responses |
vpcLink | software.amazon.awscdk.services.apigateway.IVpcLink | cdk.support/lookup-entry | :vpc-link |
The build-step-functions-execution-integration-options-builder function updates a StepFunctionsExecutionIntegrationOptions$Builder instance using the provided configuration. The function takes the StepFunctionsExecutionIntegrationOptions$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 | |---|---|---|---| | `authorizer` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:authorizer` | | `cacheKeyParameters` | java.util.List | [[cdk.support/lookup-entry]] | `:cache-key-parameters` | | `cacheNamespace` | java.lang.String | [[cdk.support/lookup-entry]] | `:cache-namespace` | | `connectionType` | software.amazon.awscdk.services.apigateway.ConnectionType | [[cdk.api.services.apigateway/connection-type]] | `:connection-type` | | `contentHandling` | software.amazon.awscdk.services.apigateway.ContentHandling | [[cdk.api.services.apigateway/content-handling]] | `:content-handling` | | `credentialsPassthrough` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:credentials-passthrough` | | `credentialsRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:credentials-role` | | `headers` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:headers` | | `integrationResponses` | java.util.List | [[cdk.support/lookup-entry]] | `:integration-responses` | | `passthroughBehavior` | software.amazon.awscdk.services.apigateway.PassthroughBehavior | [[cdk.api.services.apigateway/passthrough-behavior]] | `:passthrough-behavior` | | `path` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:path` | | `querystring` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:querystring` | | `requestContext` | software.amazon.awscdk.services.apigateway.RequestContext | [[cdk.support/lookup-entry]] | `:request-context` | | `requestParameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-parameters` | | `requestTemplates` | java.util.Map | [[cdk.support/lookup-entry]] | `:request-templates` | | `timeout` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:timeout` | | `useDefaultMethodResponses` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:use-default-method-responses` | | `vpcLink` | software.amazon.awscdk.services.apigateway.IVpcLink | [[cdk.support/lookup-entry]] | `:vpc-link` |
(build-step-functions-rest-api-builder builder id config)
The build-step-functions-rest-api-builder function updates a StepFunctionsRestApi$Builder instance using the provided configuration. The function takes the StepFunctionsRestApi$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 |
---|---|---|---|
apiKeySourceType | software.amazon.awscdk.services.apigateway.ApiKeySourceType | cdk.api.services.apigateway/api-key-source-type | :api-key-source-type |
authorizer | java.lang.Boolean | cdk.support/lookup-entry | :authorizer |
binaryMediaTypes | java.util.List | cdk.support/lookup-entry | :binary-media-types |
cloneFrom | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :clone-from |
cloudWatchRole | java.lang.Boolean | cdk.support/lookup-entry | :cloud-watch-role |
cloudWatchRoleRemovalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :cloud-watch-role-removal-policy |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
deploy | java.lang.Boolean | cdk.support/lookup-entry | :deploy |
deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | cdk.support/lookup-entry | :deploy-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | cdk.support/lookup-entry | :domain-name |
endpointConfiguration | software.amazon.awscdk.services.apigateway.EndpointConfiguration | cdk.support/lookup-entry | :endpoint-configuration |
endpointExportName | java.lang.String | cdk.support/lookup-entry | :endpoint-export-name |
endpointTypes | java.util.List | cdk.support/lookup-entry | :endpoint-types |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
headers | java.lang.Boolean | cdk.support/lookup-entry | :headers |
minCompressionSize | software.amazon.awscdk.Size | cdk.support/lookup-entry | :min-compression-size |
minimumCompressionSize | java.lang.Number | cdk.support/lookup-entry | :minimum-compression-size |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
path | java.lang.Boolean | cdk.support/lookup-entry | :path |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
querystring | java.lang.Boolean | cdk.support/lookup-entry | :querystring |
requestContext | software.amazon.awscdk.services.apigateway.RequestContext | cdk.support/lookup-entry | :request-context |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
role | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :role |
stateMachine | software.amazon.awscdk.services.stepfunctions.IStateMachine | cdk.support/lookup-entry | :state-machine |
useDefaultMethodResponses | java.lang.Boolean | cdk.support/lookup-entry | :use-default-method-responses |
The build-step-functions-rest-api-builder function updates a StepFunctionsRestApi$Builder instance using the provided configuration. The function takes the StepFunctionsRestApi$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 | |---|---|---|---| | `apiKeySourceType` | software.amazon.awscdk.services.apigateway.ApiKeySourceType | [[cdk.api.services.apigateway/api-key-source-type]] | `:api-key-source-type` | | `authorizer` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:authorizer` | | `binaryMediaTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:binary-media-types` | | `cloneFrom` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:clone-from` | | `cloudWatchRole` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cloud-watch-role` | | `cloudWatchRoleRemovalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:cloud-watch-role-removal-policy` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `deploy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy` | | `deployOptions` | software.amazon.awscdk.services.apigateway.StageOptions | [[cdk.support/lookup-entry]] | `:deploy-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `domainName` | software.amazon.awscdk.services.apigateway.DomainNameOptions | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointConfiguration` | software.amazon.awscdk.services.apigateway.EndpointConfiguration | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `endpointExportName` | java.lang.String | [[cdk.support/lookup-entry]] | `:endpoint-export-name` | | `endpointTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:endpoint-types` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `headers` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:headers` | | `minCompressionSize` | software.amazon.awscdk.Size | [[cdk.support/lookup-entry]] | `:min-compression-size` | | `minimumCompressionSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:minimum-compression-size` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `path` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:path` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `querystring` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:querystring` | | `requestContext` | software.amazon.awscdk.services.apigateway.RequestContext | [[cdk.support/lookup-entry]] | `:request-context` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` | | `role` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:role` | | `stateMachine` | software.amazon.awscdk.services.stepfunctions.IStateMachine | [[cdk.support/lookup-entry]] | `:state-machine` | | `useDefaultMethodResponses` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:use-default-method-responses` |
(build-step-functions-rest-api-props-builder builder id config)
The build-step-functions-rest-api-props-builder function updates a StepFunctionsRestApiProps$Builder instance using the provided configuration. The function takes the StepFunctionsRestApiProps$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 |
---|---|---|---|
apiKeySourceType | software.amazon.awscdk.services.apigateway.ApiKeySourceType | cdk.api.services.apigateway/api-key-source-type | :api-key-source-type |
authorizer | java.lang.Boolean | cdk.support/lookup-entry | :authorizer |
binaryMediaTypes | java.util.List | cdk.support/lookup-entry | :binary-media-types |
cloneFrom | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :clone-from |
cloudWatchRole | java.lang.Boolean | cdk.support/lookup-entry | :cloud-watch-role |
cloudWatchRoleRemovalPolicy | software.amazon.awscdk.RemovalPolicy | cdk.api/removal-policy | :cloud-watch-role-removal-policy |
defaultCorsPreflightOptions | software.amazon.awscdk.services.apigateway.CorsOptions | cdk.support/lookup-entry | :default-cors-preflight-options |
defaultIntegration | software.amazon.awscdk.services.apigateway.Integration | cdk.support/lookup-entry | :default-integration |
defaultMethodOptions | software.amazon.awscdk.services.apigateway.MethodOptions | cdk.support/lookup-entry | :default-method-options |
deploy | java.lang.Boolean | cdk.support/lookup-entry | :deploy |
deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | cdk.support/lookup-entry | :deploy-options |
description | java.lang.String | cdk.support/lookup-entry | :description |
disableExecuteApiEndpoint | java.lang.Boolean | cdk.support/lookup-entry | :disable-execute-api-endpoint |
domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | cdk.support/lookup-entry | :domain-name |
endpointConfiguration | software.amazon.awscdk.services.apigateway.EndpointConfiguration | cdk.support/lookup-entry | :endpoint-configuration |
endpointExportName | java.lang.String | cdk.support/lookup-entry | :endpoint-export-name |
endpointTypes | java.util.List | cdk.support/lookup-entry | :endpoint-types |
failOnWarnings | java.lang.Boolean | cdk.support/lookup-entry | :fail-on-warnings |
headers | java.lang.Boolean | cdk.support/lookup-entry | :headers |
minCompressionSize | software.amazon.awscdk.Size | cdk.support/lookup-entry | :min-compression-size |
minimumCompressionSize | java.lang.Number | cdk.support/lookup-entry | :minimum-compression-size |
parameters | java.util.Map | cdk.support/lookup-entry | :parameters |
path | java.lang.Boolean | cdk.support/lookup-entry | :path |
policy | software.amazon.awscdk.services.iam.PolicyDocument | cdk.support/lookup-entry | :policy |
querystring | java.lang.Boolean | cdk.support/lookup-entry | :querystring |
requestContext | software.amazon.awscdk.services.apigateway.RequestContext | cdk.support/lookup-entry | :request-context |
restApiName | java.lang.String | cdk.support/lookup-entry | :rest-api-name |
retainDeployments | java.lang.Boolean | cdk.support/lookup-entry | :retain-deployments |
role | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :role |
stateMachine | software.amazon.awscdk.services.stepfunctions.IStateMachine | cdk.support/lookup-entry | :state-machine |
useDefaultMethodResponses | java.lang.Boolean | cdk.support/lookup-entry | :use-default-method-responses |
The build-step-functions-rest-api-props-builder function updates a StepFunctionsRestApiProps$Builder instance using the provided configuration. The function takes the StepFunctionsRestApiProps$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 | |---|---|---|---| | `apiKeySourceType` | software.amazon.awscdk.services.apigateway.ApiKeySourceType | [[cdk.api.services.apigateway/api-key-source-type]] | `:api-key-source-type` | | `authorizer` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:authorizer` | | `binaryMediaTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:binary-media-types` | | `cloneFrom` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:clone-from` | | `cloudWatchRole` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:cloud-watch-role` | | `cloudWatchRoleRemovalPolicy` | software.amazon.awscdk.RemovalPolicy | [[cdk.api/removal-policy]] | `:cloud-watch-role-removal-policy` | | `defaultCorsPreflightOptions` | software.amazon.awscdk.services.apigateway.CorsOptions | [[cdk.support/lookup-entry]] | `:default-cors-preflight-options` | | `defaultIntegration` | software.amazon.awscdk.services.apigateway.Integration | [[cdk.support/lookup-entry]] | `:default-integration` | | `defaultMethodOptions` | software.amazon.awscdk.services.apigateway.MethodOptions | [[cdk.support/lookup-entry]] | `:default-method-options` | | `deploy` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:deploy` | | `deployOptions` | software.amazon.awscdk.services.apigateway.StageOptions | [[cdk.support/lookup-entry]] | `:deploy-options` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `disableExecuteApiEndpoint` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:disable-execute-api-endpoint` | | `domainName` | software.amazon.awscdk.services.apigateway.DomainNameOptions | [[cdk.support/lookup-entry]] | `:domain-name` | | `endpointConfiguration` | software.amazon.awscdk.services.apigateway.EndpointConfiguration | [[cdk.support/lookup-entry]] | `:endpoint-configuration` | | `endpointExportName` | java.lang.String | [[cdk.support/lookup-entry]] | `:endpoint-export-name` | | `endpointTypes` | java.util.List | [[cdk.support/lookup-entry]] | `:endpoint-types` | | `failOnWarnings` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:fail-on-warnings` | | `headers` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:headers` | | `minCompressionSize` | software.amazon.awscdk.Size | [[cdk.support/lookup-entry]] | `:min-compression-size` | | `minimumCompressionSize` | java.lang.Number | [[cdk.support/lookup-entry]] | `:minimum-compression-size` | | `parameters` | java.util.Map | [[cdk.support/lookup-entry]] | `:parameters` | | `path` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:path` | | `policy` | software.amazon.awscdk.services.iam.PolicyDocument | [[cdk.support/lookup-entry]] | `:policy` | | `querystring` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:querystring` | | `requestContext` | software.amazon.awscdk.services.apigateway.RequestContext | [[cdk.support/lookup-entry]] | `:request-context` | | `restApiName` | java.lang.String | [[cdk.support/lookup-entry]] | `:rest-api-name` | | `retainDeployments` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:retain-deployments` | | `role` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:role` | | `stateMachine` | software.amazon.awscdk.services.stepfunctions.IStateMachine | [[cdk.support/lookup-entry]] | `:state-machine` | | `useDefaultMethodResponses` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:use-default-method-responses` |
(build-throttle-settings-builder builder id config)
The build-throttle-settings-builder function updates a ThrottleSettings$Builder instance using the provided configuration. The function takes the ThrottleSettings$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 |
---|---|---|---|
burstLimit | java.lang.Number | cdk.support/lookup-entry | :burst-limit |
rateLimit | java.lang.Number | cdk.support/lookup-entry | :rate-limit |
The build-throttle-settings-builder function updates a ThrottleSettings$Builder instance using the provided configuration. The function takes the ThrottleSettings$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 | |---|---|---|---| | `burstLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:burst-limit` | | `rateLimit` | java.lang.Number | [[cdk.support/lookup-entry]] | `:rate-limit` |
(build-throttling-per-method-builder builder id config)
The build-throttling-per-method-builder function updates a ThrottlingPerMethod$Builder instance using the provided configuration. The function takes the ThrottlingPerMethod$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 |
---|---|---|---|
method | software.amazon.awscdk.services.apigateway.Method | cdk.support/lookup-entry | :method |
throttle | software.amazon.awscdk.services.apigateway.ThrottleSettings | cdk.support/lookup-entry | :throttle |
The build-throttling-per-method-builder function updates a ThrottlingPerMethod$Builder instance using the provided configuration. The function takes the ThrottlingPerMethod$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 | |---|---|---|---| | `method` | software.amazon.awscdk.services.apigateway.Method | [[cdk.support/lookup-entry]] | `:method` | | `throttle` | software.amazon.awscdk.services.apigateway.ThrottleSettings | [[cdk.support/lookup-entry]] | `:throttle` |
(build-token-authorizer-builder builder id config)
The build-token-authorizer-builder function updates a TokenAuthorizer$Builder instance using the provided configuration. The function takes the TokenAuthorizer$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 |
---|---|---|---|
assumeRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :assume-role |
authorizerName | java.lang.String | cdk.support/lookup-entry | :authorizer-name |
handler | software.amazon.awscdk.services.lambda.IFunction | cdk.support/lookup-entry | :handler |
identitySource | java.lang.String | cdk.support/lookup-entry | :identity-source |
resultsCacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :results-cache-ttl |
validationRegex | java.lang.String | cdk.support/lookup-entry | :validation-regex |
The build-token-authorizer-builder function updates a TokenAuthorizer$Builder instance using the provided configuration. The function takes the TokenAuthorizer$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 | |---|---|---|---| | `assumeRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:assume-role` | | `authorizerName` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-name` | | `handler` | software.amazon.awscdk.services.lambda.IFunction | [[cdk.support/lookup-entry]] | `:handler` | | `identitySource` | java.lang.String | [[cdk.support/lookup-entry]] | `:identity-source` | | `resultsCacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:results-cache-ttl` | | `validationRegex` | java.lang.String | [[cdk.support/lookup-entry]] | `:validation-regex` |
(build-token-authorizer-props-builder builder id config)
The build-token-authorizer-props-builder function updates a TokenAuthorizerProps$Builder instance using the provided configuration. The function takes the TokenAuthorizerProps$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 |
---|---|---|---|
assumeRole | software.amazon.awscdk.services.iam.IRole | cdk.support/lookup-entry | :assume-role |
authorizerName | java.lang.String | cdk.support/lookup-entry | :authorizer-name |
handler | software.amazon.awscdk.services.lambda.IFunction | cdk.support/lookup-entry | :handler |
identitySource | java.lang.String | cdk.support/lookup-entry | :identity-source |
resultsCacheTtl | software.amazon.awscdk.Duration | cdk.support/lookup-entry | :results-cache-ttl |
validationRegex | java.lang.String | cdk.support/lookup-entry | :validation-regex |
The build-token-authorizer-props-builder function updates a TokenAuthorizerProps$Builder instance using the provided configuration. The function takes the TokenAuthorizerProps$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 | |---|---|---|---| | `assumeRole` | software.amazon.awscdk.services.iam.IRole | [[cdk.support/lookup-entry]] | `:assume-role` | | `authorizerName` | java.lang.String | [[cdk.support/lookup-entry]] | `:authorizer-name` | | `handler` | software.amazon.awscdk.services.lambda.IFunction | [[cdk.support/lookup-entry]] | `:handler` | | `identitySource` | java.lang.String | [[cdk.support/lookup-entry]] | `:identity-source` | | `resultsCacheTtl` | software.amazon.awscdk.Duration | [[cdk.support/lookup-entry]] | `:results-cache-ttl` | | `validationRegex` | java.lang.String | [[cdk.support/lookup-entry]] | `:validation-regex` |
(build-usage-plan-builder builder id config)
The build-usage-plan-builder function updates a UsagePlan$Builder instance using the provided configuration. The function takes the UsagePlan$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 |
---|---|---|---|
apiStages | java.util.List | cdk.support/lookup-entry | :api-stages |
description | java.lang.String | cdk.support/lookup-entry | :description |
name | java.lang.String | cdk.support/lookup-entry | :name |
quota | software.amazon.awscdk.services.apigateway.QuotaSettings | cdk.support/lookup-entry | :quota |
throttle | software.amazon.awscdk.services.apigateway.ThrottleSettings | cdk.support/lookup-entry | :throttle |
The build-usage-plan-builder function updates a UsagePlan$Builder instance using the provided configuration. The function takes the UsagePlan$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 | |---|---|---|---| | `apiStages` | java.util.List | [[cdk.support/lookup-entry]] | `:api-stages` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `quota` | software.amazon.awscdk.services.apigateway.QuotaSettings | [[cdk.support/lookup-entry]] | `:quota` | | `throttle` | software.amazon.awscdk.services.apigateway.ThrottleSettings | [[cdk.support/lookup-entry]] | `:throttle` |
(build-usage-plan-per-api-stage-builder builder id config)
The build-usage-plan-per-api-stage-builder function updates a UsagePlanPerApiStage$Builder instance using the provided configuration. The function takes the UsagePlanPerApiStage$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 |
---|---|---|---|
api | software.amazon.awscdk.services.apigateway.IRestApi | cdk.support/lookup-entry | :api |
stage | software.amazon.awscdk.services.apigateway.Stage | cdk.support/lookup-entry | :stage |
throttle | java.util.List | cdk.support/lookup-entry | :throttle |
The build-usage-plan-per-api-stage-builder function updates a UsagePlanPerApiStage$Builder instance using the provided configuration. The function takes the UsagePlanPerApiStage$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 | |---|---|---|---| | `api` | software.amazon.awscdk.services.apigateway.IRestApi | [[cdk.support/lookup-entry]] | `:api` | | `stage` | software.amazon.awscdk.services.apigateway.Stage | [[cdk.support/lookup-entry]] | `:stage` | | `throttle` | java.util.List | [[cdk.support/lookup-entry]] | `:throttle` |
(build-usage-plan-props-builder builder id config)
The build-usage-plan-props-builder function updates a UsagePlanProps$Builder instance using the provided configuration. The function takes the UsagePlanProps$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 |
---|---|---|---|
apiStages | java.util.List | cdk.support/lookup-entry | :api-stages |
description | java.lang.String | cdk.support/lookup-entry | :description |
name | java.lang.String | cdk.support/lookup-entry | :name |
quota | software.amazon.awscdk.services.apigateway.QuotaSettings | cdk.support/lookup-entry | :quota |
throttle | software.amazon.awscdk.services.apigateway.ThrottleSettings | cdk.support/lookup-entry | :throttle |
The build-usage-plan-props-builder function updates a UsagePlanProps$Builder instance using the provided configuration. The function takes the UsagePlanProps$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 | |---|---|---|---| | `apiStages` | java.util.List | [[cdk.support/lookup-entry]] | `:api-stages` | | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `quota` | software.amazon.awscdk.services.apigateway.QuotaSettings | [[cdk.support/lookup-entry]] | `:quota` | | `throttle` | software.amazon.awscdk.services.apigateway.ThrottleSettings | [[cdk.support/lookup-entry]] | `:throttle` |
(build-vpc-link-builder builder id config)
The build-vpc-link-builder function updates a VpcLink$Builder instance using the provided configuration. The function takes the VpcLink$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
targets | java.util.List | cdk.support/lookup-entry | :targets |
vpcLinkName | java.lang.String | cdk.support/lookup-entry | :vpc-link-name |
The build-vpc-link-builder function updates a VpcLink$Builder instance using the provided configuration. The function takes the VpcLink$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `targets` | java.util.List | [[cdk.support/lookup-entry]] | `:targets` | | `vpcLinkName` | java.lang.String | [[cdk.support/lookup-entry]] | `:vpc-link-name` |
(build-vpc-link-props-builder builder id config)
The build-vpc-link-props-builder function updates a VpcLinkProps$Builder instance using the provided configuration. The function takes the VpcLinkProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
description | java.lang.String | cdk.support/lookup-entry | :description |
targets | java.util.List | cdk.support/lookup-entry | :targets |
vpcLinkName | java.lang.String | cdk.support/lookup-entry | :vpc-link-name |
The build-vpc-link-props-builder function updates a VpcLinkProps$Builder instance using the provided configuration. The function takes the VpcLinkProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `description` | java.lang.String | [[cdk.support/lookup-entry]] | `:description` | | `targets` | java.util.List | [[cdk.support/lookup-entry]] | `:targets` | | `vpcLinkName` | java.lang.String | [[cdk.support/lookup-entry]] | `:vpc-link-name` |
(cfn-account-builder scope id config)
Creates a CfnAccount$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 `CfnAccount$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-account-props-builder id config)
Creates a CfnAccountProps$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 `CfnAccountProps$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-api-key-builder scope id config)
Creates a CfnApiKey$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 `CfnApiKey$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-api-key-props-builder id config)
Creates a CfnApiKeyProps$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 `CfnApiKeyProps$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-api-key-stage-key-property-builder id config)
Creates a CfnApiKey$StageKeyProperty$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 `CfnApiKey$StageKeyProperty$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-authorizer-builder scope id config)
Creates a CfnAuthorizer$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 `CfnAuthorizer$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-authorizer-props-builder id config)
Creates a CfnAuthorizerProps$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 `CfnAuthorizerProps$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-base-path-mapping-builder scope id config)
Creates a CfnBasePathMapping$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 `CfnBasePathMapping$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-base-path-mapping-props-builder id config)
Creates a CfnBasePathMappingProps$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 `CfnBasePathMappingProps$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-client-certificate-builder scope id config)
Creates a CfnClientCertificate$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 `CfnClientCertificate$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-client-certificate-props-builder id config)
Creates a CfnClientCertificateProps$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 `CfnClientCertificateProps$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-deployment-access-log-setting-property-builder id config)
Creates a CfnDeployment$AccessLogSettingProperty$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 `CfnDeployment$AccessLogSettingProperty$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-deployment-builder scope id config)
Creates a CfnDeployment$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 `CfnDeployment$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-deployment-canary-setting-property-builder id config)
Creates a CfnDeployment$CanarySettingProperty$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 `CfnDeployment$CanarySettingProperty$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-deployment-deployment-canary-settings-property-builder id config)
Creates a CfnDeployment$DeploymentCanarySettingsProperty$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 `CfnDeployment$DeploymentCanarySettingsProperty$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-deployment-method-setting-property-builder id config)
Creates a CfnDeployment$MethodSettingProperty$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 `CfnDeployment$MethodSettingProperty$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-deployment-props-builder id config)
Creates a CfnDeploymentProps$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 `CfnDeploymentProps$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-deployment-stage-description-property-builder id config)
Creates a CfnDeployment$StageDescriptionProperty$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 `CfnDeployment$StageDescriptionProperty$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-documentation-part-builder scope id config)
Creates a CfnDocumentationPart$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 `CfnDocumentationPart$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-documentation-part-location-property-builder id config)
Creates a CfnDocumentationPart$LocationProperty$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 `CfnDocumentationPart$LocationProperty$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-documentation-part-props-builder id config)
Creates a CfnDocumentationPartProps$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 `CfnDocumentationPartProps$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-documentation-version-builder scope id config)
Creates a CfnDocumentationVersion$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 `CfnDocumentationVersion$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-documentation-version-props-builder id config)
Creates a CfnDocumentationVersionProps$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 `CfnDocumentationVersionProps$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-domain-name-builder scope id config)
Creates a CfnDomainName$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 `CfnDomainName$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-domain-name-endpoint-configuration-property-builder id config)
Creates a CfnDomainName$EndpointConfigurationProperty$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 `CfnDomainName$EndpointConfigurationProperty$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-domain-name-mutual-tls-authentication-property-builder id config)
Creates a CfnDomainName$MutualTlsAuthenticationProperty$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 `CfnDomainName$MutualTlsAuthenticationProperty$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-domain-name-props-builder id config)
Creates a CfnDomainNameProps$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 `CfnDomainNameProps$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-gateway-response-builder scope id config)
Creates a CfnGatewayResponse$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 `CfnGatewayResponse$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-gateway-response-props-builder id config)
Creates a CfnGatewayResponseProps$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 `CfnGatewayResponseProps$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-method-builder scope id config)
Creates a CfnMethod$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 `CfnMethod$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-method-integration-property-builder id config)
Creates a CfnMethod$IntegrationProperty$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 `CfnMethod$IntegrationProperty$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-method-integration-response-property-builder id config)
Creates a CfnMethod$IntegrationResponseProperty$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 `CfnMethod$IntegrationResponseProperty$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-method-method-response-property-builder id config)
Creates a CfnMethod$MethodResponseProperty$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 `CfnMethod$MethodResponseProperty$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-method-props-builder id config)
Creates a CfnMethodProps$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 `CfnMethodProps$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-model-builder scope id config)
Creates a CfnModel$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 `CfnModel$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-model-props-builder id config)
Creates a CfnModelProps$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 `CfnModelProps$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-request-validator-builder scope id config)
Creates a CfnRequestValidator$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 `CfnRequestValidator$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-request-validator-props-builder id config)
Creates a CfnRequestValidatorProps$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 `CfnRequestValidatorProps$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-resource-builder scope id config)
Creates a CfnResource$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 `CfnResource$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-resource-props-builder id config)
Creates a CfnResourceProps$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 `CfnResourceProps$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-rest-api-builder scope id config)
Creates a CfnRestApi$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 `CfnRestApi$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-rest-api-endpoint-configuration-property-builder id config)
Creates a CfnRestApi$EndpointConfigurationProperty$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 `CfnRestApi$EndpointConfigurationProperty$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-rest-api-props-builder id config)
Creates a CfnRestApiProps$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 `CfnRestApiProps$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-rest-api-s3-location-property-builder id config)
Creates a CfnRestApi$S3LocationProperty$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 `CfnRestApi$S3LocationProperty$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-stage-access-log-setting-property-builder id config)
Creates a CfnStage$AccessLogSettingProperty$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 `CfnStage$AccessLogSettingProperty$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-stage-builder scope id config)
Creates a CfnStage$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 `CfnStage$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-stage-canary-setting-property-builder id config)
Creates a CfnStage$CanarySettingProperty$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 `CfnStage$CanarySettingProperty$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-stage-method-setting-property-builder id config)
Creates a CfnStage$MethodSettingProperty$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 `CfnStage$MethodSettingProperty$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-stage-props-builder id config)
Creates a CfnStageProps$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 `CfnStageProps$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-usage-plan-api-stage-property-builder id config)
Creates a CfnUsagePlan$ApiStageProperty$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 `CfnUsagePlan$ApiStageProperty$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-usage-plan-builder scope id config)
Creates a CfnUsagePlan$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 `CfnUsagePlan$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-usage-plan-key-builder scope id config)
Creates a CfnUsagePlanKey$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 `CfnUsagePlanKey$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-usage-plan-key-props-builder id config)
Creates a CfnUsagePlanKeyProps$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 `CfnUsagePlanKeyProps$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-usage-plan-props-builder id config)
Creates a CfnUsagePlanProps$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 `CfnUsagePlanProps$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-usage-plan-quota-settings-property-builder id config)
Creates a CfnUsagePlan$QuotaSettingsProperty$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 `CfnUsagePlan$QuotaSettingsProperty$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-usage-plan-throttle-settings-property-builder id config)
Creates a CfnUsagePlan$ThrottleSettingsProperty$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 `CfnUsagePlan$ThrottleSettingsProperty$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-vpc-link-builder scope id config)
Creates a CfnVpcLink$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 `CfnVpcLink$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-vpc-link-props-builder id config)
Creates a CfnVpcLinkProps$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 `CfnVpcLinkProps$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 |
(cognito-user-pools-authorizer-builder scope id config)
Creates a CognitoUserPoolsAuthorizer$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 `CognitoUserPoolsAuthorizer$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 |
(cognito-user-pools-authorizer-props-builder id config)
Creates a CognitoUserPoolsAuthorizerProps$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 `CognitoUserPoolsAuthorizerProps$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 |
(connection-type config id item-key)
The connection-type
function data interprets values in the provided config data into a
ConnectionType
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:
ConnectionType
- the value is returned.:vpc-link
- ConnectionType/VPC_LINK
is returned:internet
- ConnectionType/INTERNET
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `connection-type` function data interprets values in the provided config data into a `ConnectionType` 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 `ConnectionType` - the value is returned. * is `:vpc-link` - `ConnectionType/VPC_LINK` is returned * is `:internet` - `ConnectionType/INTERNET` is returned If a value is not found or matches the above criteria, nil is returned.
(content-handling config id item-key)
The content-handling
function data interprets values in the provided config data into a
ContentHandling
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:
ContentHandling
- the value is returned.:convert-to-binary
- ContentHandling/CONVERT_TO_BINARY
is returned:convert-to-text
- ContentHandling/CONVERT_TO_TEXT
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `content-handling` function data interprets values in the provided config data into a `ContentHandling` 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 `ContentHandling` - the value is returned. * is `:convert-to-binary` - `ContentHandling/CONVERT_TO_BINARY` is returned * is `:convert-to-text` - `ContentHandling/CONVERT_TO_TEXT` is returned If a value is not found or matches the above criteria, nil is returned.
(cors-options-builder id config)
Creates a CorsOptions$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 `CorsOptions$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 |
(deployment-builder scope id config)
Creates a Deployment$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 `Deployment$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 |
(deployment-props-builder id config)
Creates a DeploymentProps$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 `DeploymentProps$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 |
(domain-name-attributes-builder id config)
Creates a DomainNameAttributes$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 `DomainNameAttributes$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 |
(domain-name-builder scope id config)
Creates a DomainName$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 `DomainName$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 |
(domain-name-options-builder id config)
Creates a DomainNameOptions$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 `DomainNameOptions$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 |
(domain-name-props-builder id config)
Creates a DomainNameProps$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 `DomainNameProps$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 |
(endpoint-configuration-builder id config)
Creates a EndpointConfiguration$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 `EndpointConfiguration$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 |
(endpoint-type config id item-key)
The endpoint-type
function data interprets values in the provided config data into a
EndpointType
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:
EndpointType
- the value is returned.:edge
- EndpointType/EDGE
is returned:private
- EndpointType/PRIVATE
is returned:regional
- EndpointType/REGIONAL
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `endpoint-type` function data interprets values in the provided config data into a `EndpointType` 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 `EndpointType` - the value is returned. * is `:edge` - `EndpointType/EDGE` is returned * is `:private` - `EndpointType/PRIVATE` is returned * is `:regional` - `EndpointType/REGIONAL` is returned If a value is not found or matches the above criteria, nil is returned.
(gateway-response-builder scope id config)
Creates a GatewayResponse$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 `GatewayResponse$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 |
(gateway-response-options-builder id config)
Creates a GatewayResponseOptions$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 `GatewayResponseOptions$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 |
(gateway-response-props-builder id config)
Creates a GatewayResponseProps$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 `GatewayResponseProps$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 |
(http-integration-builder url id config)
Creates a HttpIntegration$Builder
instance using provided forms, applies the data configuration, then builds it. Takes the following arguments:
Create Form: _[java.lang.String] | Argument | DataType | Description | |---|---|---| | url | 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 `HttpIntegration$Builder` instance using provided forms, applies the data configuration, then builds it. Takes the following arguments: __Create Form:__ ____[java.lang.String]___ | Argument | DataType | Description | |---|---|---| | url | java.lang.String | | | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(http-integration-props-builder id config)
Creates a HttpIntegrationProps$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 `HttpIntegrationProps$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 |
(integration-builder id config)
Creates a Integration$Builder
instance using a no-argument create, 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 `Integration$Builder` instance using a no-argument create, 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 |
(integration-config-builder id config)
Creates a IntegrationConfig$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 `IntegrationConfig$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 |
(integration-options-builder id config)
Creates a IntegrationOptions$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 `IntegrationOptions$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 |
(integration-props-builder id config)
Creates a IntegrationProps$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 `IntegrationProps$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 |
(integration-response-builder id config)
Creates a IntegrationResponse$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 `IntegrationResponse$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 |
(integration-type config id item-key)
The integration-type
function data interprets values in the provided config data into a
IntegrationType
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:
IntegrationType
- the value is returned.:http-proxy
- IntegrationType/HTTP_PROXY
is returned:mock
- IntegrationType/MOCK
is returned:aws
- IntegrationType/AWS
is returned:aws-proxy
- IntegrationType/AWS_PROXY
is returned:http
- IntegrationType/HTTP
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `integration-type` function data interprets values in the provided config data into a `IntegrationType` 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 `IntegrationType` - the value is returned. * is `:http-proxy` - `IntegrationType/HTTP_PROXY` is returned * is `:mock` - `IntegrationType/MOCK` is returned * is `:aws` - `IntegrationType/AWS` is returned * is `:aws-proxy` - `IntegrationType/AWS_PROXY` is returned * is `:http` - `IntegrationType/HTTP` is returned If a value is not found or matches the above criteria, nil is returned.
(json-schema-builder id config)
Creates a JsonSchema$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 `JsonSchema$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 |
(json-schema-type config id item-key)
The json-schema-type
function data interprets values in the provided config data into a
JsonSchemaType
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:
JsonSchemaType
- the value is returned.:array
- JsonSchemaType/ARRAY
is returned:number
- JsonSchemaType/NUMBER
is returned:null
- JsonSchemaType/NULL
is returned:boolean
- JsonSchemaType/BOOLEAN
is returned:integer
- JsonSchemaType/INTEGER
is returned:object
- JsonSchemaType/OBJECT
is returned:string
- JsonSchemaType/STRING
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `json-schema-type` function data interprets values in the provided config data into a `JsonSchemaType` 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 `JsonSchemaType` - the value is returned. * is `:array` - `JsonSchemaType/ARRAY` is returned * is `:number` - `JsonSchemaType/NUMBER` is returned * is `:null` - `JsonSchemaType/NULL` is returned * is `:boolean` - `JsonSchemaType/BOOLEAN` is returned * is `:integer` - `JsonSchemaType/INTEGER` is returned * is `:object` - `JsonSchemaType/OBJECT` is returned * is `:string` - `JsonSchemaType/STRING` is returned If a value is not found or matches the above criteria, nil is returned.
(json-schema-version config id item-key)
The json-schema-version
function data interprets values in the provided config data into a
JsonSchemaVersion
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:
JsonSchemaVersion
- the value is returned.:draft4
- JsonSchemaVersion/DRAFT4
is returned:draft7
- JsonSchemaVersion/DRAFT7
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `json-schema-version` function data interprets values in the provided config data into a `JsonSchemaVersion` 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 `JsonSchemaVersion` - the value is returned. * is `:draft4` - `JsonSchemaVersion/DRAFT4` is returned * is `:draft7` - `JsonSchemaVersion/DRAFT7` is returned If a value is not found or matches the above criteria, nil is returned.
(json-with-standard-field-props-builder id config)
Creates a JsonWithStandardFieldProps$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 `JsonWithStandardFieldProps$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 |
(lambda-authorizer-props-builder id config)
Creates a LambdaAuthorizerProps$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 `LambdaAuthorizerProps$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 |
(lambda-integration-builder handler id config)
Creates a LambdaIntegration$Builder
instance using provided forms, applies the data configuration, then builds it. Takes the following arguments:
Create Form: _[software.amazon.awscdk.services.lambda.IFunction] | Argument | DataType | Description | |---|---|---| | handler | software.amazon.awscdk.services.lambda.IFunction | | | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
Creates a `LambdaIntegration$Builder` instance using provided forms, applies the data configuration, then builds it. Takes the following arguments: __Create Form:__ ____[software.amazon.awscdk.services.lambda.IFunction]___ | Argument | DataType | Description | |---|---|---| | handler | software.amazon.awscdk.services.lambda.IFunction | | | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(lambda-integration-options-builder id config)
Creates a LambdaIntegrationOptions$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 `LambdaIntegrationOptions$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 |
(lambda-rest-api-builder scope id config)
Creates a LambdaRestApi$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 `LambdaRestApi$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 |
(lambda-rest-api-props-builder id config)
Creates a LambdaRestApiProps$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 `LambdaRestApiProps$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 |
(method-builder scope id config)
Creates a Method$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 `Method$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 |
(method-deployment-options-builder id config)
Creates a MethodDeploymentOptions$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 `MethodDeploymentOptions$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 |
(method-logging-level config id item-key)
The method-logging-level
function data interprets values in the provided config data into a
MethodLoggingLevel
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:
MethodLoggingLevel
- the value is returned.:off
- MethodLoggingLevel/OFF
is returned:info
- MethodLoggingLevel/INFO
is returned:error
- MethodLoggingLevel/ERROR
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `method-logging-level` function data interprets values in the provided config data into a `MethodLoggingLevel` 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 `MethodLoggingLevel` - the value is returned. * is `:off` - `MethodLoggingLevel/OFF` is returned * is `:info` - `MethodLoggingLevel/INFO` is returned * is `:error` - `MethodLoggingLevel/ERROR` is returned If a value is not found or matches the above criteria, nil is returned.
(method-options-builder id config)
Creates a MethodOptions$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 `MethodOptions$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 |
(method-props-builder id config)
Creates a MethodProps$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 `MethodProps$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 |
(method-response-builder id config)
Creates a MethodResponse$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 `MethodResponse$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 |
(mock-integration-builder id config)
Creates a MockIntegration$Builder
instance using a no-argument create, 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 `MockIntegration$Builder` instance using a no-argument create, 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 |
(model-builder scope id config)
Creates a Model$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 `Model$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 |
(model-options-builder id config)
Creates a ModelOptions$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 `ModelOptions$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 |
(model-props-builder id config)
Creates a ModelProps$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 `ModelProps$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 |
(mtls-config-builder id config)
Creates a MTLSConfig$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 `MTLSConfig$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 |
(passthrough-behavior config id item-key)
The passthrough-behavior
function data interprets values in the provided config data into a
PassthroughBehavior
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:
PassthroughBehavior
- the value is returned.:never
- PassthroughBehavior/NEVER
is returned:when-no-match
- PassthroughBehavior/WHEN_NO_MATCH
is returned:when-no-templates
- PassthroughBehavior/WHEN_NO_TEMPLATES
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `passthrough-behavior` function data interprets values in the provided config data into a `PassthroughBehavior` 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 `PassthroughBehavior` - the value is returned. * is `:never` - `PassthroughBehavior/NEVER` is returned * is `:when-no-match` - `PassthroughBehavior/WHEN_NO_MATCH` is returned * is `:when-no-templates` - `PassthroughBehavior/WHEN_NO_TEMPLATES` is returned If a value is not found or matches the above criteria, nil is returned.
(period config id item-key)
The period
function data interprets values in the provided config data into a
Period
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:
Period
- the value is returned.:day
- Period/DAY
is returned:week
- Period/WEEK
is returned:month
- Period/MONTH
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `period` function data interprets values in the provided config data into a `Period` 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 `Period` - the value is returned. * is `:day` - `Period/DAY` is returned * is `:week` - `Period/WEEK` is returned * is `:month` - `Period/MONTH` is returned If a value is not found or matches the above criteria, nil is returned.
(proxy-resource-builder scope id config)
Creates a ProxyResource$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 `ProxyResource$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 |
(proxy-resource-options-builder id config)
Creates a ProxyResourceOptions$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 `ProxyResourceOptions$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 |
(proxy-resource-props-builder id config)
Creates a ProxyResourceProps$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 `ProxyResourceProps$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 |
(quota-settings-builder id config)
Creates a QuotaSettings$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 `QuotaSettings$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 |
(rate-limited-api-key-builder scope id config)
Creates a RateLimitedApiKey$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 `RateLimitedApiKey$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 |
(rate-limited-api-key-props-builder id config)
Creates a RateLimitedApiKeyProps$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 `RateLimitedApiKeyProps$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 |
(request-authorizer-builder scope id config)
Creates a RequestAuthorizer$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 `RequestAuthorizer$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 |
(request-authorizer-props-builder id config)
Creates a RequestAuthorizerProps$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 `RequestAuthorizerProps$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 |
(request-context-builder id config)
Creates a RequestContext$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 `RequestContext$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 |
(request-validator-builder scope id config)
Creates a RequestValidator$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 `RequestValidator$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 |
(request-validator-options-builder id config)
Creates a RequestValidatorOptions$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 `RequestValidatorOptions$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 |
(request-validator-props-builder id config)
Creates a RequestValidatorProps$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 `RequestValidatorProps$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 |
(resource-attributes-builder id config)
Creates a ResourceAttributes$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 `ResourceAttributes$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 |
(resource-builder scope id config)
Creates a Resource$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 `Resource$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 |
(resource-options-builder id config)
Creates a ResourceOptions$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 `ResourceOptions$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 |
(resource-props-builder id config)
Creates a ResourceProps$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 `ResourceProps$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 |
(rest-api-attributes-builder id config)
Creates a RestApiAttributes$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 `RestApiAttributes$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 |
(rest-api-base-props-builder id config)
Creates a RestApiBaseProps$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 `RestApiBaseProps$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 |
(rest-api-builder scope id config)
Creates a RestApi$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 `RestApi$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 |
(rest-api-props-builder id config)
Creates a RestApiProps$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 `RestApiProps$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 |
(sagemaker-integration-builder endpoint id config)
Creates a SagemakerIntegration$Builder
instance using provided forms, applies the data configuration, then builds it. Takes the following arguments:
Create Form: _[software.amazon.awscdk.services.sagemaker.IEndpoint] | Argument | DataType | Description | |---|---|---| | endpoint | software.amazon.awscdk.services.sagemaker.IEndpoint | | | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
Creates a `SagemakerIntegration$Builder` instance using provided forms, applies the data configuration, then builds it. Takes the following arguments: __Create Form:__ ____[software.amazon.awscdk.services.sagemaker.IEndpoint]___ | Argument | DataType | Description | |---|---|---| | endpoint | software.amazon.awscdk.services.sagemaker.IEndpoint | | | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(sagemaker-integration-options-builder id config)
Creates a SagemakerIntegrationOptions$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 `SagemakerIntegrationOptions$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 |
(security-policy config id item-key)
The security-policy
function data interprets values in the provided config data into a
SecurityPolicy
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:
SecurityPolicy
- the value is returned.:tls-1-0
- SecurityPolicy/TLS_1_0
is returned:tls-1-2
- SecurityPolicy/TLS_1_2
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `security-policy` function data interprets values in the provided config data into a `SecurityPolicy` 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 `SecurityPolicy` - the value is returned. * is `:tls-1-0` - `SecurityPolicy/TLS_1_0` is returned * is `:tls-1-2` - `SecurityPolicy/TLS_1_2` is returned If a value is not found or matches the above criteria, nil is returned.
(spec-rest-api-builder scope id config)
Creates a SpecRestApi$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 `SpecRestApi$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 |
(spec-rest-api-props-builder id config)
Creates a SpecRestApiProps$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 `SpecRestApiProps$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 |
(stage-attributes-builder id config)
Creates a StageAttributes$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 `StageAttributes$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 |
(stage-builder scope id config)
Creates a Stage$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 `Stage$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 |
(stage-options-builder id config)
Creates a StageOptions$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 `StageOptions$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 |
(stage-props-builder id config)
Creates a StageProps$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 `StageProps$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 |
(step-functions-execution-integration-options-builder id config)
Creates a StepFunctionsExecutionIntegrationOptions$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 `StepFunctionsExecutionIntegrationOptions$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 |
(step-functions-rest-api-builder scope id config)
Creates a StepFunctionsRestApi$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 `StepFunctionsRestApi$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 |
(step-functions-rest-api-props-builder id config)
Creates a StepFunctionsRestApiProps$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 `StepFunctionsRestApiProps$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 |
(throttle-settings-builder id config)
Creates a ThrottleSettings$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 `ThrottleSettings$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 |
(throttling-per-method-builder id config)
Creates a ThrottlingPerMethod$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 `ThrottlingPerMethod$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 |
(token-authorizer-builder scope id config)
Creates a TokenAuthorizer$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 `TokenAuthorizer$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 |
(token-authorizer-props-builder id config)
Creates a TokenAuthorizerProps$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 `TokenAuthorizerProps$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 |
(usage-plan-builder scope id config)
Creates a UsagePlan$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 `UsagePlan$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 |
(usage-plan-per-api-stage-builder id config)
Creates a UsagePlanPerApiStage$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 `UsagePlanPerApiStage$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 |
(usage-plan-props-builder id config)
Creates a UsagePlanProps$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 `UsagePlanProps$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 |
(vpc-link-builder scope id config)
Creates a VpcLink$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 `VpcLink$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 |
(vpc-link-props-builder id config)
Creates a VpcLinkProps$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 `VpcLinkProps$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