Liking cljdoc? Tell your friends :D

cdk.api.services.codestarnotifications

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. 
raw docstring

build-cfn-notification-rule-builderclj

(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:

FieldDataTypeLookup FunctionData Key
createdByjava.lang.Stringcdk.support/lookup-entry:created-by
detailTypejava.lang.Stringcdk.support/lookup-entry:detail-type
eventTypeIdjava.lang.Stringcdk.support/lookup-entry:event-type-id
eventTypeIdsjava.util.Listcdk.support/lookup-entry:event-type-ids
namejava.lang.Stringcdk.support/lookup-entry:name
resourcejava.lang.Stringcdk.support/lookup-entry:resource
statusjava.lang.Stringcdk.support/lookup-entry:status
tagsjava.util.Mapcdk.support/lookup-entry:tags
targetAddressjava.lang.Stringcdk.support/lookup-entry:target-address
targetsjava.util.Listcdk.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` |
sourceraw docstring

build-cfn-notification-rule-props-builderclj

(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:

FieldDataTypeLookup FunctionData Key
createdByjava.lang.Stringcdk.support/lookup-entry:created-by
detailTypejava.lang.Stringcdk.support/lookup-entry:detail-type
eventTypeIdjava.lang.Stringcdk.support/lookup-entry:event-type-id
eventTypeIdsjava.util.Listcdk.support/lookup-entry:event-type-ids
namejava.lang.Stringcdk.support/lookup-entry:name
resourcejava.lang.Stringcdk.support/lookup-entry:resource
statusjava.lang.Stringcdk.support/lookup-entry:status
tagsjava.util.Mapcdk.support/lookup-entry:tags
targetAddressjava.lang.Stringcdk.support/lookup-entry:target-address
targetssoftware.amazon.awscdk.IResolvablecdk.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` |
sourceraw docstring

build-cfn-notification-rule-target-property-builderclj

(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:

FieldDataTypeLookup FunctionData Key
targetAddressjava.lang.Stringcdk.support/lookup-entry:target-address
targetTypejava.lang.Stringcdk.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` |
sourceraw docstring

build-notification-rule-builderclj

(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:

FieldDataTypeLookup FunctionData Key
detailTypesoftware.amazon.awscdk.services.codestarnotifications.DetailTypecdk.api.services.codestarnotifications/detail-type:detail-type
enabledjava.lang.Booleancdk.support/lookup-entry:enabled
eventsjava.util.Listcdk.support/lookup-entry:events
notificationRuleNamejava.lang.Stringcdk.support/lookup-entry:notification-rule-name
sourcesoftware.amazon.awscdk.services.codestarnotifications.INotificationRuleSourcecdk.support/lookup-entry:source
targetsjava.util.Listcdk.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` |
sourceraw docstring

build-notification-rule-options-builderclj

(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:

FieldDataTypeLookup FunctionData Key
detailTypesoftware.amazon.awscdk.services.codestarnotifications.DetailTypecdk.api.services.codestarnotifications/detail-type:detail-type
enabledjava.lang.Booleancdk.support/lookup-entry:enabled
notificationRuleNamejava.lang.Stringcdk.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` |
sourceraw docstring

build-notification-rule-props-builderclj

(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:

FieldDataTypeLookup FunctionData Key
detailTypesoftware.amazon.awscdk.services.codestarnotifications.DetailTypecdk.api.services.codestarnotifications/detail-type:detail-type
enabledjava.lang.Booleancdk.support/lookup-entry:enabled
eventsjava.util.Listcdk.support/lookup-entry:events
notificationRuleNamejava.lang.Stringcdk.support/lookup-entry:notification-rule-name
sourcesoftware.amazon.awscdk.services.codestarnotifications.INotificationRuleSourcecdk.support/lookup-entry:source
targetsjava.util.Listcdk.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` |
sourceraw docstring

build-notification-rule-source-config-builderclj

(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:

FieldDataTypeLookup FunctionData Key
sourceArnjava.lang.Stringcdk.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` |
sourceraw docstring

build-notification-rule-target-config-builderclj

(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:

FieldDataTypeLookup FunctionData Key
targetAddressjava.lang.Stringcdk.support/lookup-entry:target-address
targetTypejava.lang.Stringcdk.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` |
sourceraw docstring

cfn-notification-rule-builderclj

(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 |
sourceraw docstring

cfn-notification-rule-props-builderclj

(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:

ArgumentDataTypeDescription
idString or Keyword or SymbolValue to use as namespace when looking up configuration values.
configmapData 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 |
sourceraw docstring

cfn-notification-rule-target-property-builderclj

(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:

ArgumentDataTypeDescription
idString or Keyword or SymbolValue to use as namespace when looking up configuration values.
configmapData 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 |
sourceraw docstring

detail-typeclj

(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:

  • 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.

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.
sourceraw docstring

notification-rule-builderclj

(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 |
sourceraw docstring

notification-rule-options-builderclj

(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:

ArgumentDataTypeDescription
idString or Keyword or SymbolValue to use as namespace when looking up configuration values.
configmapData 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 |
sourceraw docstring

notification-rule-props-builderclj

(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:

ArgumentDataTypeDescription
idString or Keyword or SymbolValue to use as namespace when looking up configuration values.
configmapData 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 |
sourceraw docstring

notification-rule-source-config-builderclj

(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:

ArgumentDataTypeDescription
idString or Keyword or SymbolValue to use as namespace when looking up configuration values.
configmapData 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 |
sourceraw docstring

notification-rule-target-config-builderclj

(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:

ArgumentDataTypeDescription
idString or Keyword or SymbolValue to use as namespace when looking up configuration values.
configmapData 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 |
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close