codestarnotifications¶

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-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.codestarnotifications.NotificationRule(resource_name, opts=None, detail_type=None, event_type_ids=None, name=None, resource=None, status=None, tags=None, targets=None, __props__=None, __name__=None, __opts__=None)¶

Provides a CodeStar Notifications Rule.

import pulumi
import pulumi_aws as aws

code = aws.codecommit.Repository("code", repository_name="example-code-repo")
notif = aws.sns.Topic("notif")
notif_access = aws.iam.get_policy_document(statement=[{
    "actions": ["sns:Publish"],
    "principals": [{
        "type": "Service",
        "identifiers": ["codestar-notifications.amazonaws.com"],
    }],
    "resources": [notif.arn],
}])
default = aws.sns.TopicPolicy("default",
    arn=notif.arn,
    policy=notif_access.json)
commits = aws.codestarnotifications.NotificationRule("commits",
    detail_type="BASIC",
    event_type_ids=["codecommit-repository-comments-on-commits"],
    resource=code.arn,
    target=[{
        "address": notif.arn,
    }])

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• detail_type (pulumi.Input[str]) – The level of detail to include in the notifications for this resource. Possible values are BASIC and FULL.

• event_type_ids (pulumi.Input[list]) – A list of event types associated with this notification rule. For list of allowed events see here.

• name (pulumi.Input[str]) – The name of notification rule.

• resource (pulumi.Input[str]) – The ARN of the resource to associate with the notification rule.

• status (pulumi.Input[str]) – The status of the notification rule. Possible values are ENABLED and DISABLED, default is ENABLED.

• tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

• targets (pulumi.Input[list]) – Configuration blocks containing notification target information. Can be specified multiple times. At least one target must be specified on creation.

The targets object supports the following:

• address (pulumi.Input[str]) - The ARN of notification rule target. For example, a SNS Topic ARN.

• status (pulumi.Input[str]) - The status of the notification rule. Possible values are ENABLED and DISABLED, default is ENABLED.

• type (pulumi.Input[str]) - The type of the notification target. Default value is SNS.

arn: pulumi.Output[str] = None¶

The codestar notification rule ARN.

detail_type: pulumi.Output[str] = None¶

The level of detail to include in the notifications for this resource. Possible values are BASIC and FULL.

event_type_ids: pulumi.Output[list] = None¶

A list of event types associated with this notification rule. For list of allowed events see here.

name: pulumi.Output[str] = None¶

The name of notification rule.

resource: pulumi.Output[str] = None¶

The ARN of the resource to associate with the notification rule.

status: pulumi.Output[str] = None¶

The status of the notification rule. Possible values are ENABLED and DISABLED, default is ENABLED.

tags: pulumi.Output[dict] = None¶

A map of tags to assign to the resource.

targets: pulumi.Output[list] = None¶

Configuration blocks containing notification target information. Can be specified multiple times. At least one target must be specified on creation.

• address (str) - The ARN of notification rule target. For example, a SNS Topic ARN.

• status (str) - The status of the notification rule. Possible values are ENABLED and DISABLED, default is ENABLED.

• type (str) - The type of the notification target. Default value is SNS.

static get(resource_name, id, opts=None, arn=None, detail_type=None, event_type_ids=None, name=None, resource=None, status=None, tags=None, targets=None)¶

Get an existing NotificationRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• arn (pulumi.Input[str]) – The codestar notification rule ARN.

• detail_type (pulumi.Input[str]) – The level of detail to include in the notifications for this resource. Possible values are BASIC and FULL.

• event_type_ids (pulumi.Input[list]) –

  A list of event types associated with this notification rule. For list of allowed events see here.

• name (pulumi.Input[str]) – The name of notification rule.

• resource (pulumi.Input[str]) – The ARN of the resource to associate with the notification rule.

• status (pulumi.Input[str]) – The status of the notification rule. Possible values are ENABLED and DISABLED, default is ENABLED.

• tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

• targets (pulumi.Input[list]) – Configuration blocks containing notification target information. Can be specified multiple times. At least one target must be specified on creation.

The targets object supports the following:

• address (pulumi.Input[str]) - The ARN of notification rule target. For example, a SNS Topic ARN.

• status (pulumi.Input[str]) - The status of the notification rule. Possible values are ENABLED and DISABLED, default is ENABLED.

• type (pulumi.Input[str]) - The type of the notification target. Default value is SNS.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str