@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
125 lines (124 loc) • 6.84 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::CodeStarNotifications::NotificationRule
*/
export declare class NotificationRule extends pulumi.CustomResource {
/**
* Get an existing NotificationRule resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): NotificationRule;
/**
* Returns true if the given object is an instance of NotificationRule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is NotificationRule;
/**
* The Amazon Resource Name (ARN) of the notification rule.
*/
readonly arn: pulumi.Output<string>;
/**
* The name or email alias of the person who created the notification rule.
*/
readonly createdBy: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly detailType: pulumi.Output<enums.codestarnotifications.NotificationRuleDetailType>;
/**
* The event type associated with this notification rule. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide* .
*/
readonly eventTypeId: pulumi.Output<string | undefined>;
/**
* A list of event types associated with this notification rule. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide* .
*/
readonly eventTypeIds: pulumi.Output<string[]>;
/**
* The name for the notification rule. Notification rule names must be unique in your AWS account .
*/
readonly name: pulumi.Output<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 .
*/
readonly resource: pulumi.Output<string>;
/**
* 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.
*/
readonly status: pulumi.Output<enums.codestarnotifications.NotificationRuleStatus | undefined>;
/**
* A list of tags to apply to this notification rule. Key names cannot start with " `aws` ".
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The Amazon Resource Name (ARN) of the Amazon SNS topic or client.
*/
readonly targetAddress: pulumi.Output<string | undefined>;
/**
* A list of Amazon Resource Names (ARNs) of Amazon SNS topics and clients to associate with the notification rule.
*/
readonly targets: pulumi.Output<outputs.codestarnotifications.NotificationRuleTarget[]>;
/**
* Create a NotificationRule resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: NotificationRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a NotificationRule resource.
*/
export interface NotificationRuleArgs {
/**
* The name or email alias of the person who created the notification rule.
*/
createdBy?: pulumi.Input<string>;
/**
* 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.
*/
detailType: pulumi.Input<enums.codestarnotifications.NotificationRuleDetailType>;
/**
* The event type associated with this notification rule. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide* .
*/
eventTypeId?: pulumi.Input<string>;
/**
* A list of event types associated with this notification rule. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide* .
*/
eventTypeIds: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name for the notification rule. Notification rule names must be unique in your AWS account .
*/
name?: pulumi.Input<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 .
*/
resource: pulumi.Input<string>;
/**
* 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.
*/
status?: pulumi.Input<enums.codestarnotifications.NotificationRuleStatus>;
/**
* A list of tags to apply to this notification rule. Key names cannot start with " `aws` ".
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The Amazon Resource Name (ARN) of the Amazon SNS topic or client.
*/
targetAddress?: pulumi.Input<string>;
/**
* A list of Amazon Resource Names (ARNs) of Amazon SNS topics and clients to associate with the notification rule.
*/
targets: pulumi.Input<pulumi.Input<inputs.codestarnotifications.NotificationRuleTargetArgs>[]>;
}