We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi
aws-native.codestarnotifications.getNotificationRule
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi
Resource Type definition for AWS::CodeStarNotifications::NotificationRule
Using getNotificationRule
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getNotificationRule(args: GetNotificationRuleArgs, opts?: InvokeOptions): Promise<GetNotificationRuleResult>
function getNotificationRuleOutput(args: GetNotificationRuleOutputArgs, opts?: InvokeOptions): Output<GetNotificationRuleResult>
def get_notification_rule(arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetNotificationRuleResult
def get_notification_rule_output(arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNotificationRuleResult]
func LookupNotificationRule(ctx *Context, args *LookupNotificationRuleArgs, opts ...InvokeOption) (*LookupNotificationRuleResult, error)
func LookupNotificationRuleOutput(ctx *Context, args *LookupNotificationRuleOutputArgs, opts ...InvokeOption) LookupNotificationRuleResultOutput
> Note: This function is named LookupNotificationRule
in the Go SDK.
public static class GetNotificationRule
{
public static Task<GetNotificationRuleResult> InvokeAsync(GetNotificationRuleArgs args, InvokeOptions? opts = null)
public static Output<GetNotificationRuleResult> Invoke(GetNotificationRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNotificationRuleResult> getNotificationRule(GetNotificationRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:codestarnotifications:getNotificationRule
arguments:
# arguments dictionary
The following arguments are supported:
- Arn string
- The Amazon Resource Name (ARN) of the notification rule.
- Arn string
- The Amazon Resource Name (ARN) of the notification rule.
- arn String
- The Amazon Resource Name (ARN) of the notification rule.
- arn string
- The Amazon Resource Name (ARN) of the notification rule.
- arn str
- The Amazon Resource Name (ARN) of the notification rule.
- arn String
- The Amazon Resource Name (ARN) of the notification rule.
getNotificationRule Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the notification rule.
- Created
By string - The name or email alias of the person who created the notification rule.
- Detail
Type Pulumi.Aws Native. Code Star Notifications. Notification Rule Detail Type - 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 List<string>Ids - 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 .
- Name string
- The name for the notification rule. Notification rule names must be unique in your AWS account .
- Status
Pulumi.
Aws Native. Code Star Notifications. Notification Rule Status - The status of the notification rule. The default value is
ENABLED
. If the status is set toDISABLED
, notifications aren't sent for the notification rule. - Dictionary<string, string>
- A list of tags to apply to this notification rule. Key names cannot start with "
aws
". - Targets
List<Pulumi.
Aws Native. Code Star Notifications. Outputs. Notification Rule Target> - A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
- Arn string
- The Amazon Resource Name (ARN) of the notification rule.
- Created
By string - The name or email alias of the person who created the notification rule.
- Detail
Type NotificationRule Detail Type - 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 []stringIds - 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 .
- Name string
- The name for the notification rule. Notification rule names must be unique in your AWS account .
- Status
Notification
Rule Status - The status of the notification rule. The default value is
ENABLED
. If the status is set toDISABLED
, notifications aren't sent for the notification rule. - map[string]string
- A list of tags to apply to this notification rule. Key names cannot start with "
aws
". - Targets
[]Notification
Rule Target - A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
- arn String
- The Amazon Resource Name (ARN) of the notification rule.
- created
By String - The name or email alias of the person who created the notification rule.
- detail
Type NotificationRule Detail Type - 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 List<String>Ids - 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 .
- name String
- The name for the notification rule. Notification rule names must be unique in your AWS account .
- status
Notification
Rule Status - The status of the notification rule. The default value is
ENABLED
. If the status is set toDISABLED
, notifications aren't sent for the notification rule. - Map<String,String>
- A list of tags to apply to this notification rule. Key names cannot start with "
aws
". - targets
List<Notification
Rule Target> - A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
- arn string
- The Amazon Resource Name (ARN) of the notification rule.
- created
By string - The name or email alias of the person who created the notification rule.
- detail
Type NotificationRule Detail Type - 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 string[]Ids - 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 .
- name string
- The name for the notification rule. Notification rule names must be unique in your AWS account .
- status
Notification
Rule Status - The status of the notification rule. The default value is
ENABLED
. If the status is set toDISABLED
, notifications aren't sent for the notification rule. - {[key: string]: string}
- A list of tags to apply to this notification rule. Key names cannot start with "
aws
". - targets
Notification
Rule Target[] - A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
- arn str
- The Amazon Resource Name (ARN) of the notification rule.
- created_
by str - The name or email alias of the person who created the notification rule.
- detail_
type NotificationRule Detail Type - 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_ Sequence[str]ids - 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 .
- name str
- The name for the notification rule. Notification rule names must be unique in your AWS account .
- status
Notification
Rule Status - The status of the notification rule. The default value is
ENABLED
. If the status is set toDISABLED
, notifications aren't sent for the notification rule. - Mapping[str, str]
- A list of tags to apply to this notification rule. Key names cannot start with "
aws
". - targets
Sequence[Notification
Rule Target] - A list of Amazon Resource Names (ARNs) of Amazon SNS topics and AWS Chatbot clients to associate with the notification rule.
- arn String
- The Amazon Resource Name (ARN) of the notification rule.
- created
By String - The name or email alias of the person who created the notification rule.
- detail
Type "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. - event
Type List<String>Ids - 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 .
- 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 toDISABLED
, notifications aren't sent for the notification rule. - Map<String>
- A list of tags to apply to this notification rule. Key names cannot start with "
aws
". - 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.
Supporting Types
NotificationRuleDetailType
NotificationRuleStatus
NotificationRuleTarget
- Target
Address string - The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
- Target
Type 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
.
- Amazon Simple Notification Service topics are specified as
- Target
Address string - The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
- Target
Type 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
.
- Amazon Simple Notification Service topics are specified as
- target
Address String - The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
- target
Type 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
.
- Amazon Simple Notification Service topics are specified as
- target
Address string - The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
- target
Type 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
.
- Amazon Simple Notification Service topics are specified as
- 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
.
- Amazon Simple Notification Service topics are specified as
- target
Address String - The Amazon Resource Name (ARN) of the AWS Chatbot topic or AWS Chatbot client.
- target
Type 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
.
- Amazon Simple Notification Service topics are specified as
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi