Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.codestarnotifications package.
Functions that represent AWS CDK enums and builders in the software.amazon.awscdk.services.codestarnotifications package.
(build-cfn-notification-rule-builder builder id config)
The build-cfn-notification-rule-builder function updates a CfnNotificationRule$Builder instance using the provided configuration. The function takes the CfnNotificationRule$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
createdBy | java.lang.String | cdk.support/lookup-entry | :created-by |
detailType | java.lang.String | cdk.support/lookup-entry | :detail-type |
eventTypeId | java.lang.String | cdk.support/lookup-entry | :event-type-id |
eventTypeIds | java.util.List | cdk.support/lookup-entry | :event-type-ids |
name | java.lang.String | cdk.support/lookup-entry | :name |
resource | java.lang.String | cdk.support/lookup-entry | :resource |
status | java.lang.String | cdk.support/lookup-entry | :status |
tags | java.util.Map | cdk.support/lookup-entry | :tags |
targetAddress | java.lang.String | cdk.support/lookup-entry | :target-address |
targets | java.util.List | cdk.support/lookup-entry | :targets |
The build-cfn-notification-rule-builder function updates a CfnNotificationRule$Builder instance using the provided configuration. The function takes the CfnNotificationRule$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `createdBy` | java.lang.String | [[cdk.support/lookup-entry]] | `:created-by` | | `detailType` | java.lang.String | [[cdk.support/lookup-entry]] | `:detail-type` | | `eventTypeId` | java.lang.String | [[cdk.support/lookup-entry]] | `:event-type-id` | | `eventTypeIds` | java.util.List | [[cdk.support/lookup-entry]] | `:event-type-ids` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `resource` | java.lang.String | [[cdk.support/lookup-entry]] | `:resource` | | `status` | java.lang.String | [[cdk.support/lookup-entry]] | `:status` | | `tags` | java.util.Map | [[cdk.support/lookup-entry]] | `:tags` | | `targetAddress` | java.lang.String | [[cdk.support/lookup-entry]] | `:target-address` | | `targets` | java.util.List | [[cdk.support/lookup-entry]] | `:targets` |
(build-cfn-notification-rule-props-builder builder id config)
The build-cfn-notification-rule-props-builder function updates a CfnNotificationRuleProps$Builder instance using the provided configuration. The function takes the CfnNotificationRuleProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
createdBy | java.lang.String | cdk.support/lookup-entry | :created-by |
detailType | java.lang.String | cdk.support/lookup-entry | :detail-type |
eventTypeId | java.lang.String | cdk.support/lookup-entry | :event-type-id |
eventTypeIds | java.util.List | cdk.support/lookup-entry | :event-type-ids |
name | java.lang.String | cdk.support/lookup-entry | :name |
resource | java.lang.String | cdk.support/lookup-entry | :resource |
status | java.lang.String | cdk.support/lookup-entry | :status |
tags | java.util.Map | cdk.support/lookup-entry | :tags |
targetAddress | java.lang.String | cdk.support/lookup-entry | :target-address |
targets | software.amazon.awscdk.IResolvable | cdk.support/lookup-entry | :targets |
The build-cfn-notification-rule-props-builder function updates a CfnNotificationRuleProps$Builder instance using the provided configuration. The function takes the CfnNotificationRuleProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `createdBy` | java.lang.String | [[cdk.support/lookup-entry]] | `:created-by` | | `detailType` | java.lang.String | [[cdk.support/lookup-entry]] | `:detail-type` | | `eventTypeId` | java.lang.String | [[cdk.support/lookup-entry]] | `:event-type-id` | | `eventTypeIds` | java.util.List | [[cdk.support/lookup-entry]] | `:event-type-ids` | | `name` | java.lang.String | [[cdk.support/lookup-entry]] | `:name` | | `resource` | java.lang.String | [[cdk.support/lookup-entry]] | `:resource` | | `status` | java.lang.String | [[cdk.support/lookup-entry]] | `:status` | | `tags` | java.util.Map | [[cdk.support/lookup-entry]] | `:tags` | | `targetAddress` | java.lang.String | [[cdk.support/lookup-entry]] | `:target-address` | | `targets` | software.amazon.awscdk.IResolvable | [[cdk.support/lookup-entry]] | `:targets` |
(build-cfn-notification-rule-target-property-builder builder id config)
The build-cfn-notification-rule-target-property-builder function updates a CfnNotificationRule$TargetProperty$Builder instance using the provided configuration. The function takes the CfnNotificationRule$TargetProperty$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
targetAddress | java.lang.String | cdk.support/lookup-entry | :target-address |
targetType | java.lang.String | cdk.support/lookup-entry | :target-type |
The build-cfn-notification-rule-target-property-builder function updates a CfnNotificationRule$TargetProperty$Builder instance using the provided configuration. The function takes the CfnNotificationRule$TargetProperty$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `targetAddress` | java.lang.String | [[cdk.support/lookup-entry]] | `:target-address` | | `targetType` | java.lang.String | [[cdk.support/lookup-entry]] | `:target-type` |
(build-notification-rule-builder builder id config)
The build-notification-rule-builder function updates a NotificationRule$Builder instance using the provided configuration. The function takes the NotificationRule$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
detailType | software.amazon.awscdk.services.codestarnotifications.DetailType | cdk.api.services.codestarnotifications/detail-type | :detail-type |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
events | java.util.List | cdk.support/lookup-entry | :events |
notificationRuleName | java.lang.String | cdk.support/lookup-entry | :notification-rule-name |
source | software.amazon.awscdk.services.codestarnotifications.INotificationRuleSource | cdk.support/lookup-entry | :source |
targets | java.util.List | cdk.support/lookup-entry | :targets |
The build-notification-rule-builder function updates a NotificationRule$Builder instance using the provided configuration. The function takes the NotificationRule$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `detailType` | software.amazon.awscdk.services.codestarnotifications.DetailType | [[cdk.api.services.codestarnotifications/detail-type]] | `:detail-type` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `events` | java.util.List | [[cdk.support/lookup-entry]] | `:events` | | `notificationRuleName` | java.lang.String | [[cdk.support/lookup-entry]] | `:notification-rule-name` | | `source` | software.amazon.awscdk.services.codestarnotifications.INotificationRuleSource | [[cdk.support/lookup-entry]] | `:source` | | `targets` | java.util.List | [[cdk.support/lookup-entry]] | `:targets` |
(build-notification-rule-options-builder builder id config)
The build-notification-rule-options-builder function updates a NotificationRuleOptions$Builder instance using the provided configuration. The function takes the NotificationRuleOptions$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
detailType | software.amazon.awscdk.services.codestarnotifications.DetailType | cdk.api.services.codestarnotifications/detail-type | :detail-type |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
notificationRuleName | java.lang.String | cdk.support/lookup-entry | :notification-rule-name |
The build-notification-rule-options-builder function updates a NotificationRuleOptions$Builder instance using the provided configuration. The function takes the NotificationRuleOptions$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `detailType` | software.amazon.awscdk.services.codestarnotifications.DetailType | [[cdk.api.services.codestarnotifications/detail-type]] | `:detail-type` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `notificationRuleName` | java.lang.String | [[cdk.support/lookup-entry]] | `:notification-rule-name` |
(build-notification-rule-props-builder builder id config)
The build-notification-rule-props-builder function updates a NotificationRuleProps$Builder instance using the provided configuration. The function takes the NotificationRuleProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
detailType | software.amazon.awscdk.services.codestarnotifications.DetailType | cdk.api.services.codestarnotifications/detail-type | :detail-type |
enabled | java.lang.Boolean | cdk.support/lookup-entry | :enabled |
events | java.util.List | cdk.support/lookup-entry | :events |
notificationRuleName | java.lang.String | cdk.support/lookup-entry | :notification-rule-name |
source | software.amazon.awscdk.services.codestarnotifications.INotificationRuleSource | cdk.support/lookup-entry | :source |
targets | java.util.List | cdk.support/lookup-entry | :targets |
The build-notification-rule-props-builder function updates a NotificationRuleProps$Builder instance using the provided configuration. The function takes the NotificationRuleProps$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `detailType` | software.amazon.awscdk.services.codestarnotifications.DetailType | [[cdk.api.services.codestarnotifications/detail-type]] | `:detail-type` | | `enabled` | java.lang.Boolean | [[cdk.support/lookup-entry]] | `:enabled` | | `events` | java.util.List | [[cdk.support/lookup-entry]] | `:events` | | `notificationRuleName` | java.lang.String | [[cdk.support/lookup-entry]] | `:notification-rule-name` | | `source` | software.amazon.awscdk.services.codestarnotifications.INotificationRuleSource | [[cdk.support/lookup-entry]] | `:source` | | `targets` | java.util.List | [[cdk.support/lookup-entry]] | `:targets` |
(build-notification-rule-source-config-builder builder id config)
The build-notification-rule-source-config-builder function updates a NotificationRuleSourceConfig$Builder instance using the provided configuration. The function takes the NotificationRuleSourceConfig$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
sourceArn | java.lang.String | cdk.support/lookup-entry | :source-arn |
The build-notification-rule-source-config-builder function updates a NotificationRuleSourceConfig$Builder instance using the provided configuration. The function takes the NotificationRuleSourceConfig$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `sourceArn` | java.lang.String | [[cdk.support/lookup-entry]] | `:source-arn` |
(build-notification-rule-target-config-builder builder id config)
The build-notification-rule-target-config-builder function updates a NotificationRuleTargetConfig$Builder instance using the provided configuration. The function takes the NotificationRuleTargetConfig$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself.
Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value:
Field | DataType | Lookup Function | Data Key |
---|---|---|---|
targetAddress | java.lang.String | cdk.support/lookup-entry | :target-address |
targetType | java.lang.String | cdk.support/lookup-entry | :target-type |
The build-notification-rule-target-config-builder function updates a NotificationRuleTargetConfig$Builder instance using the provided configuration. The function takes the NotificationRuleTargetConfig$Builder instance, an optional namespace to use when looking up a value in the configuration, and the configuration itself. Fields on the builder are populated by looking up their respective data key, where the namespaced value takes precendence over the non-namespaced value: | Field | DataType | Lookup Function | Data Key | |---|---|---|---| | `targetAddress` | java.lang.String | [[cdk.support/lookup-entry]] | `:target-address` | | `targetType` | java.lang.String | [[cdk.support/lookup-entry]] | `:target-type` |
(cfn-notification-rule-builder scope id config)
Creates a CfnNotificationRule$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 `CfnNotificationRule$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-notification-rule-props-builder id config)
Creates a CfnNotificationRuleProps$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following 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 `CfnNotificationRuleProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following 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-notification-rule-target-property-builder id config)
Creates a CfnNotificationRule$TargetProperty$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following 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 `CfnNotificationRule$TargetProperty$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(detail-type config id item-key)
The detail-type
function data interprets values in the provided config data into a
DetailType
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:
DetailType
- the value is returned.:basic
- DetailType/BASIC
is returned:full
- DetailType/FULL
is returnedIf a value is not found or matches the above criteria, nil is returned.
The `detail-type` function data interprets values in the provided config data into a `DetailType` 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 `DetailType` - the value is returned. * is `:basic` - `DetailType/BASIC` is returned * is `:full` - `DetailType/FULL` is returned If a value is not found or matches the above criteria, nil is returned.
(notification-rule-builder scope id config)
Creates a NotificationRule$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 `NotificationRule$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 |
(notification-rule-options-builder id config)
Creates a NotificationRuleOptions$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following 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 `NotificationRuleOptions$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(notification-rule-props-builder id config)
Creates a NotificationRuleProps$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following 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 `NotificationRuleProps$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(notification-rule-source-config-builder id config)
Creates a NotificationRuleSourceConfig$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following 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 `NotificationRuleSourceConfig$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following arguments: | Argument | DataType | Description | |---|---|---| | id | String or Keyword or Symbol | Value to use as namespace when looking up configuration values. | | config | map | Data configuration |
(notification-rule-target-config-builder id config)
Creates a NotificationRuleTargetConfig$Builder
instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following 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 `NotificationRuleTargetConfig$Builder` instance using a no-argument constructor, applies the data configuration, then builds it. Takes the following 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