Package software.amazon.awscdk.services.codestarnotifications

Enum Class DetailType

java.lang.Object

java.lang.Enum<DetailType>

software.amazon.awscdk.services.codestarnotifications.DetailType

All Implemented Interfaces:

Serializable, Comparable<DetailType>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:05.466Z")
@Stability(Stable)
public enum DetailType
extends Enum<DetailType>

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

Example:

 import software.amazon.awscdk.services.codestarnotifications.*;
 import software.amazon.awscdk.services.codebuild.*;
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.chatbot.*;
 PipelineProject project = new PipelineProject(this, "MyProject");
 Topic topic = new Topic(this, "MyTopic1");
 SlackChannelConfiguration slack = SlackChannelConfiguration.Builder.create(this, "MySlackChannel")
         .slackChannelConfigurationName("YOUR_CHANNEL_NAME")
         .slackWorkspaceId("YOUR_SLACK_WORKSPACE_ID")
         .slackChannelId("YOUR_SLACK_CHANNEL_ID")
         .build();
 NotificationRule rule = NotificationRule.Builder.create(this, "NotificationRule")
         .source(project)
         .events(List.of("codebuild-project-build-state-succeeded", "codebuild-project-build-state-failed"))
         .targets(List.of(topic))
         .notificationRuleName("MyNotificationRuleName")
         .enabled(true) // The default is true
         .detailType(DetailType.FULL) // The default is FULL
         .createdBy("Jone Doe")
         .build();
 rule.addTarget(slack);
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static DetailType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DetailType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BASIC

@Stability(Stable)
public static final DetailType BASIC

BASIC will include only the contents of the event as it would appear in AWS CloudWatch.

FULL

@Stability(Stable)
public static final DetailType FULL

FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

Method Details

values

public static DetailType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DetailType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null