Module codestarnotifications
This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the
pulumi/pulumi-awsrepo; however, if that doesn’t turn up anything, please consult the sourceterraform-providers/terraform-provider-awsrepo.
Resources
Others
Resources
Resource NotificationRule
class NotificationRule extends CustomResourceProvides a CodeStar Notifications Rule.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const code = new aws.codecommit.Repository("code", {repositoryName: "example-code-repo"});
const notif = new aws.sns.Topic("notif", {});
const notifAccess = aws.iam.getPolicyDocument({
statement: [{
actions: ["sns:Publish"],
principals: [{
type: "Service",
identifiers: ["codestar-notifications.amazonaws.com"],
}],
resources: [notif.arn],
}],
});
const _default = new aws.sns.TopicPolicy("default", {
arn: notif.arn,
policy: notifAccess.json,
});
const commits = new aws.codestarnotifications.NotificationRule("commits", {
detailType: "BASIC",
eventTypeIds: ["codecommit-repository-comments-on-commits"],
resource: code.arn,
target: [{
address: notif.arn,
}],
});constructor
new NotificationRule(name: string, args: NotificationRuleArgs, opts?: pulumi.CustomResourceOptions)Create a NotificationRule resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NotificationRuleState, opts?: pulumi.CustomResourceOptions): NotificationRuleGet an existing NotificationRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is NotificationRuleReturns 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.
property arn
public arn: pulumi.Output<string>;The codestar notification rule ARN.
property detailType
public detailType: pulumi.Output<string>;The level of detail to include in the notifications for this resource. Possible values are BASIC and FULL.
property eventTypeIds
public eventTypeIds: pulumi.Output<string[]>;A list of event types associated with this notification rule. For list of allowed events see here.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property name
public name: pulumi.Output<string>;The name of notification rule.
property resource
public resource: pulumi.Output<string>;The ARN of the resource to associate with the notification rule.
property status
public status: pulumi.Output<string | undefined>;The status of the notification rule. Possible values are ENABLED and DISABLED, default is ENABLED.
property tags
public tags: pulumi.Output<{[key: string]: any} | undefined>;A map of tags to assign to the resource.
property targets
public targets: pulumi.Output<NotificationRuleTarget[] | undefined>;Configuration blocks containing notification target information. Can be specified multiple times. At least one target must be specified on creation.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Others
interface NotificationRuleArgs
interface NotificationRuleArgsThe set of arguments for constructing a NotificationRule resource.
property detailType
detailType: pulumi.Input<string>;The level of detail to include in the notifications for this resource. Possible values are BASIC and FULL.
property eventTypeIds
eventTypeIds: pulumi.Input<pulumi.Input<string>[]>;A list of event types associated with this notification rule. For list of allowed events see here.
property name
name?: pulumi.Input<string>;The name of notification rule.
property resource
resource: pulumi.Input<string>;The ARN of the resource to associate with the notification rule.
property status
status?: pulumi.Input<string>;The status of the notification rule. Possible values are ENABLED and DISABLED, default is ENABLED.
property tags
tags?: pulumi.Input<{[key: string]: any}>;A map of tags to assign to the resource.
property targets
targets?: pulumi.Input<pulumi.Input<NotificationRuleTarget>[]>;Configuration blocks containing notification target information. Can be specified multiple times. At least one target must be specified on creation.
interface NotificationRuleState
interface NotificationRuleStateInput properties used for looking up and filtering NotificationRule resources.
property arn
arn?: pulumi.Input<string>;The codestar notification rule ARN.
property detailType
detailType?: pulumi.Input<string>;The level of detail to include in the notifications for this resource. Possible values are BASIC and FULL.
property eventTypeIds
eventTypeIds?: pulumi.Input<pulumi.Input<string>[]>;A list of event types associated with this notification rule. For list of allowed events see here.
property name
name?: pulumi.Input<string>;The name of notification rule.
property resource
resource?: pulumi.Input<string>;The ARN of the resource to associate with the notification rule.
property status
status?: pulumi.Input<string>;The status of the notification rule. Possible values are ENABLED and DISABLED, default is ENABLED.
property tags
tags?: pulumi.Input<{[key: string]: any}>;A map of tags to assign to the resource.
property targets
targets?: pulumi.Input<pulumi.Input<NotificationRuleTarget>[]>;Configuration blocks containing notification target information. Can be specified multiple times. At least one target must be specified on creation.