NAME
Paws::CodeStarNotifications::CreateNotificationRule - Arguments for method CreateNotificationRule on Paws::CodeStarNotifications
DESCRIPTION
This class represents the parameters used for calling the method CreateNotificationRule on the AWS CodeStar Notifications service. Use the attributes of this class as arguments to method CreateNotificationRule.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNotificationRule.
SYNOPSIS
my $codestar-notifications = Paws->service('CodeStarNotifications');
my $CreateNotificationRuleResult =
$codestar -notifications->CreateNotificationRule(
DetailType => 'BASIC',
EventTypeIds => [
'MyEventTypeId', ... # min: 1, max: 200
],
Name => 'MyNotificationRuleName',
Resource => 'MyNotificationRuleResource',
Targets => [
{
TargetAddress => 'MyTargetAddress', # min: 1, max: 320; OPTIONAL
TargetType => 'MyTargetType', # OPTIONAL
},
...
],
ClientRequestToken => 'MyClientRequestToken', # OPTIONAL
Status => 'ENABLED', # OPTIONAL
Tags => {
'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256
}, # OPTIONAL
);
# Results:
my $Arn = $CreateNotificationRuleResult->Arn;# Returns a Paws::CodeStarNotifications::CreateNotificationRuleResult object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications/CreateNotificationRule
ATTRIBUTES
ClientRequestToken => Str
A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.
The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.
REQUIRED DetailType => Str
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 AWS 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.
Valid values are: "BASIC", "FULL"
REQUIRED EventTypeIds => ArrayRef[Str|Undef]
A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.
REQUIRED Name => Str
The name for the notification rule. Notifictaion rule names must be unique in your AWS account.
REQUIRED 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.
Status => Str
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.
Valid values are: "ENABLED", "DISABLED"
Tags => Paws::CodeStarNotifications::Tags
A list of tags to apply to this notification rule. Key names cannot start with "aws".
REQUIRED Targets => ArrayRef[Paws::CodeStarNotifications::Target]
A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateNotificationRule in Paws::CodeStarNotifications
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues