Package software.amazon.awscdk.cfnpropertymixins.services.codestarnotifications

Class CfnNotificationRulePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.codestarnotifications.CfnNotificationRulePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNotificationRulePropsMixin>

Enclosing class:

CfnNotificationRulePropsMixin

@Stability(Stable)
public static final class CfnNotificationRulePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnNotificationRulePropsMixin>

A fluent builder for CfnNotificationRulePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnNotificationRulePropsMixin	build()
static CfnNotificationRulePropsMixin.Builder	create()
static CfnNotificationRulePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnNotificationRulePropsMixin.Builder	createdBy(String createdBy)	The name or email alias of the person who created the notification rule.
CfnNotificationRulePropsMixin.Builder	detailType(String detailType)	The level of detail to include in the notifications for this resource.
CfnNotificationRulePropsMixin.Builder	eventTypeId(String eventTypeId)	The event type associated with this notification rule.
CfnNotificationRulePropsMixin.Builder	eventTypeIds(List<String> eventTypeIds)	A list of event types associated with this notification rule.
CfnNotificationRulePropsMixin.Builder	name(String name)	The name for the notification rule.
CfnNotificationRulePropsMixin.Builder	resource(String resource)	The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
CfnNotificationRulePropsMixin.Builder	status(String status)	The status of the notification rule.
CfnNotificationRulePropsMixin.Builder	tags(Map<String,String> tags)	A list of tags to apply to this notification rule.
CfnNotificationRulePropsMixin.Builder	targetAddress(String targetAddress)	The Amazon Resource Name (ARN) of the Amazon topic or client.
CfnNotificationRulePropsMixin.Builder	targets(List<? extends Object> targets)	A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule.
CfnNotificationRulePropsMixin.Builder	targets(IResolvable targets)	A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnNotificationRulePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnNotificationRulePropsMixin.Builder.

create

@Stability(Stable)
public static CfnNotificationRulePropsMixin.Builder create()

Returns:

a new instance of CfnNotificationRulePropsMixin.Builder.

createdBy

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder createdBy(String createdBy)

The name or email alias of the person who created the notification rule.

Parameters:

createdBy - The name or email alias of the person who created the notification rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-createdby

detailType

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder detailType(String detailType)

The level of detail to include in the notifications for this resource.

BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

Parameters:

detailType - The level of detail to include in the notifications for this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-detailtype

eventTypeId

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder eventTypeId(String eventTypeId)

The event type associated with this notification rule.

For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .

Parameters:

eventTypeId - The event type associated with this notification rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-eventtypeid

eventTypeIds

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder eventTypeIds(List<String> eventTypeIds)

A list of event types associated with this notification rule.

For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .

Parameters:

eventTypeIds - A list of event types associated with this notification rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-eventtypeids

name

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder name(String name)

The name for the notification rule.

Notification rule names must be unique in your AWS account .

Parameters:

name - The name for the notification rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-name

resource

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder resource(String resource)

The Amazon Resource Name (ARN) of the resource to associate with the notification rule.

Supported resources include pipelines in AWS CodePipeline , repositories in AWS CodeCommit , and build projects in AWS CodeBuild .

Parameters:

resource - The Amazon Resource Name (ARN) of the resource to associate with the notification rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-resource

status

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder status(String status)

The status of the notification rule.

The default value is ENABLED . If the status is set to DISABLED , notifications aren't sent for the notification rule.

Parameters:

status - The status of the notification rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-status

tags

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder tags(Map<String,String> tags)

A list of tags to apply to this notification rule.

Key names cannot start with " aws ".

Parameters:

tags - A list of tags to apply to this notification rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-tags

targetAddress

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder targetAddress(String targetAddress)

The Amazon Resource Name (ARN) of the Amazon topic or client.

Parameters:

targetAddress - The Amazon Resource Name (ARN) of the Amazon topic or client. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targetaddress

targets

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder targets(IResolvable targets)

A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule.

Parameters:

targets - A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targets

targets

@Stability(Stable)
public CfnNotificationRulePropsMixin.Builder targets(List<? extends Object> targets)

A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule.

Parameters:

targets - A list of Amazon Resource Names (ARNs) of Amazon topics and clients to associate with the notification rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarnotifications-notificationrule.html#cfn-codestarnotifications-notificationrule-targets

build

@Stability(Stable)
public CfnNotificationRulePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnNotificationRulePropsMixin>

Returns:

a newly built instance of CfnNotificationRulePropsMixin.