Package software.amazon.awssdk.services.codestarnotifications.model

Interface CreateNotificationRuleRequest.Builder

    • Method Detail

      • name

        CreateNotificationRuleRequest.Builder name​(String name)

        The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.

        Parameters:
        name - The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventTypeIds

        CreateNotificationRuleRequest.Builder eventTypeIds​(Collection<String> eventTypeIds)

        A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

        Parameters:
        eventTypeIds - A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventTypeIds

        CreateNotificationRuleRequest.Builder eventTypeIds​(String... eventTypeIds)

        A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

        Parameters:
        eventTypeIds - A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resource

        CreateNotificationRuleRequest.Builder resource​(String resource)

        The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline, repositories in CodeCommit, and build projects in CodeBuild.

        Parameters:
        resource - The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline, repositories in CodeCommit, and build projects in CodeBuild.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        CreateNotificationRuleRequest.Builder targets​(Collection<Target> targets)

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

        Parameters:
        targets - A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        CreateNotificationRuleRequest.Builder targets​(Target... targets)

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

        Parameters:
        targets - A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        CreateNotificationRuleRequest.Builder targets​(Consumer<Target.Builder>... targets)

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

        This is a convenience method that creates an instance of the Target.Builder avoiding the need to create one manually via Target.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #targets(List).

        Parameters:
        targets - a consumer that will call methods on Target.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #targets(java.util.Collection)

      • detailType

        CreateNotificationRuleRequest.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. 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DetailType, DetailType

      • detailType

        CreateNotificationRuleRequest.Builder detailType​(DetailType 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. 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DetailType, DetailType

      • clientRequestToken

        CreateNotificationRuleRequest.Builder clientRequestToken​(String clientRequestToken)

        A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.

        The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.

        Parameters:
        clientRequestToken - A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.

        The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateNotificationRuleRequest.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. Key names cannot start with "aws".
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        CreateNotificationRuleRequest.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. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NotificationRuleStatus, NotificationRuleStatus

      • status

        CreateNotificationRuleRequest.Builder status​(NotificationRuleStatus 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. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NotificationRuleStatus, NotificationRuleStatus