Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. codestarnotifications
  5. NotificationRule

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.codestarnotifications.NotificationRule

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::CodeStarNotifications::NotificationRule

    Create NotificationRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NotificationRule(name: string, args: NotificationRuleArgs, opts?: CustomResourceOptions);
    @overload
def NotificationRule(resource_name: str,
                     args: NotificationRuleArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def NotificationRule(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     detail_type: Optional[NotificationRuleDetailType] = None,
                     event_type_ids: Optional[Sequence[str]] = None,
                     resource: Optional[str] = None,
                     targets: Optional[Sequence[NotificationRuleTargetArgs]] = None,
                     created_by: Optional[str] = None,
                     event_type_id: Optional[str] = None,
                     name: Optional[str] = None,
                     status: Optional[NotificationRuleStatus] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     target_address: Optional[str] = None)
    func NewNotificationRule(ctx *Context, name string, args NotificationRuleArgs, opts ...ResourceOption) (*NotificationRule, error)
    public NotificationRule(string name, NotificationRuleArgs args, CustomResourceOptions? opts = null)
    public NotificationRule(String name, NotificationRuleArgs args)
public NotificationRule(String name, NotificationRuleArgs args, CustomResourceOptions options)

    type: aws-native:codestarnotifications:NotificationRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args NotificationRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NotificationRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NotificationRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    NotificationRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NotificationRule resource accepts the following input properties:

    DetailType Pulumi.AwsNative.CodeStarNotifications.NotificationRuleDetailType
    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.
    EventTypeIds List<string>
    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 .
    Resource string
    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 .
    Targets List<Pulumi.AwsNative.CodeStarNotifications.Inputs.NotificationRuleTarget>
    A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
    CreatedBy string
    The name or email alias of the person who created the notification rule.
    EventTypeId string
    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 .
    Name string
    The name for the notification rule. Notification rule names must be unique in your AWS account .
    Status Pulumi.AwsNative.CodeStarNotifications.NotificationRuleStatus
    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.
    Tags Dictionary<string, string>
    A list of tags to apply to this notification rule. Key names cannot start with " aws ".
    TargetAddress string
    The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.
    DetailType NotificationRuleDetailType
    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.
    EventTypeIds []string
    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 .
    Resource string
    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 .
    Targets []NotificationRuleTargetArgs
    A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
    CreatedBy string
    The name or email alias of the person who created the notification rule.
    EventTypeId string
    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 .
    Name string
    The name for the notification rule. Notification rule names must be unique in your AWS account .
    Status NotificationRuleStatus
    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.
    Tags map[string]string
    A list of tags to apply to this notification rule. Key names cannot start with " aws ".
    TargetAddress string
    The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.
    detailType NotificationRuleDetailType
    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.
    eventTypeIds List<String>
    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 .
    resource String
    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 .
    targets List<NotificationRuleTarget>
    A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
    createdBy String
    The name or email alias of the person who created the notification rule.
    eventTypeId String
    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 .
    name String
    The name for the notification rule. Notification rule names must be unique in your AWS account .
    status NotificationRuleStatus
    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.
    tags Map<String,String>
    A list of tags to apply to this notification rule. Key names cannot start with " aws ".
    targetAddress String
    The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.
    detailType NotificationRuleDetailType
    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.
    eventTypeIds string[]
    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 .
    resource string
    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 .
    targets NotificationRuleTarget[]
    A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
    createdBy string
    The name or email alias of the person who created the notification rule.
    eventTypeId string
    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 .
    name string
    The name for the notification rule. Notification rule names must be unique in your AWS account .
    status NotificationRuleStatus
    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.
    tags {[key: string]: string}
    A list of tags to apply to this notification rule. Key names cannot start with " aws ".
    targetAddress string
    The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.
    detail_type NotificationRuleDetailType
    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.
    event_type_ids Sequence[str]
    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 .
    resource str
    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 .
    targets Sequence[NotificationRuleTargetArgs]
    A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
    created_by str
    The name or email alias of the person who created the notification rule.
    event_type_id str
    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 .
    name str
    The name for the notification rule. Notification rule names must be unique in your AWS account .
    status NotificationRuleStatus
    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.
    tags Mapping[str, str]
    A list of tags to apply to this notification rule. Key names cannot start with " aws ".
    target_address str
    The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.
    detailType "BASIC" | "FULL"
    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.
    eventTypeIds List<String>
    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 .
    resource String
    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 .
    targets List<Property Map>
    A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
    createdBy String
    The name or email alias of the person who created the notification rule.
    eventTypeId String
    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 .
    name String
    The name for the notification rule. Notification rule names must be unique in your AWS account .
    status "ENABLED" | "DISABLED"
    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.
    tags Map<String>
    A list of tags to apply to this notification rule. Key names cannot start with " aws ".
    targetAddress String
    The Amazon Resource Name (ARN) of the Amazon SNS topic or AWS Chatbot client.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NotificationRule resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the notification rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the notification rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the notification rule.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the notification rule.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the notification rule.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the notification rule.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    NotificationRuleDetailType, NotificationRuleDetailTypeArgs

    Basic
    BASIC
    Full
    FULL
    NotificationRuleDetailTypeBasic
    BASIC
    NotificationRuleDetailTypeFull
    FULL
    Basic
    BASIC
    Full
    FULL
    Basic
    BASIC
    Full
    FULL
    BASIC
    BASIC
    FULL
    FULL
    "BASIC"
    BASIC
    "FULL"
    FULL

    NotificationRuleStatus, NotificationRuleStatusArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    NotificationRuleStatusEnabled
    ENABLED
    NotificationRuleStatusDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    NotificationRuleTarget, NotificationRuleTargetArgs

    TargetAddress string
    The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
    TargetType string
    The target type. Can be an Amazon Simple Notification Service topic or AWS Chatbot client.

    • Amazon Simple Notification Service topics are specified as SNS .
    • AWS Chatbot clients are specified as AWSChatbotSlack .
    • AWS Chatbot clients for Microsoft Teams are specified as AWSChatbotMicrosoftTeams .
    TargetAddress string
    The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
    TargetType string
    The target type. Can be an Amazon Simple Notification Service topic or AWS Chatbot client.

    • Amazon Simple Notification Service topics are specified as SNS .
    • AWS Chatbot clients are specified as AWSChatbotSlack .
    • AWS Chatbot clients for Microsoft Teams are specified as AWSChatbotMicrosoftTeams .
    targetAddress String
    The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
    targetType String
    The target type. Can be an Amazon Simple Notification Service topic or AWS Chatbot client.

    • Amazon Simple Notification Service topics are specified as SNS .
    • AWS Chatbot clients are specified as AWSChatbotSlack .
    • AWS Chatbot clients for Microsoft Teams are specified as AWSChatbotMicrosoftTeams .
    targetAddress string
    The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
    targetType string
    The target type. Can be an Amazon Simple Notification Service topic or AWS Chatbot client.

    • Amazon Simple Notification Service topics are specified as SNS .
    • AWS Chatbot clients are specified as AWSChatbotSlack .
    • AWS Chatbot clients for Microsoft Teams are specified as AWSChatbotMicrosoftTeams .
    target_address str
    The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
    target_type str
    The target type. Can be an Amazon Simple Notification Service topic or AWS Chatbot client.

    • Amazon Simple Notification Service topics are specified as SNS .
    • AWS Chatbot clients are specified as AWSChatbotSlack .
    • AWS Chatbot clients for Microsoft Teams are specified as AWSChatbotMicrosoftTeams .
    targetAddress String
    The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
    targetType String
    The target type. Can be an Amazon Simple Notification Service topic or AWS Chatbot client.

    • Amazon Simple Notification Service topics are specified as SNS .
    • AWS Chatbot clients are specified as AWSChatbotSlack .
    • AWS Chatbot clients for Microsoft Teams are specified as AWSChatbotMicrosoftTeams .

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native