Class: Aws::CodeStarNotifications::Types::CreateNotificationRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:name]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

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 Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 116

class CreateNotificationRuleRequest < Struct.new(
  :name,
  :event_type_ids,
  :resource,
  :targets,
  :detail_type,
  :client_request_token,
  :tags,
  :status)
  SENSITIVE = [:name]
  include Aws::Structure
end

#detail_type ⇒ 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 CodeStar Notifications and/or the service for the resource for which the notification is created.

Returns:

  • (String) 


116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 116

class CreateNotificationRuleRequest < Struct.new(
  :name,
  :event_type_ids,
  :resource,
  :targets,
  :detail_type,
  :client_request_token,
  :tags,
  :status)
  SENSITIVE = [:name]
  include Aws::Structure
end

#event_type_ids ⇒ Array<String>

A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

Returns:

  • (Array<String>) 


116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 116

class CreateNotificationRuleRequest < Struct.new(
  :name,
  :event_type_ids,
  :resource,
  :targets,
  :detail_type,
  :client_request_token,
  :tags,
  :status)
  SENSITIVE = [:name]
  include Aws::Structure
end

#name ⇒ String

The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.

Returns:

  • (String) 


116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 116

class CreateNotificationRuleRequest < Struct.new(
  :name,
  :event_type_ids,
  :resource,
  :targets,
  :detail_type,
  :client_request_token,
  :tags,
  :status)
  SENSITIVE = [:name]
  include Aws::Structure
end

#resource ⇒ String

The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline, repositories in CodeCommit, and build projects in CodeBuild.

Returns:

  • (String) 


116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 116

class CreateNotificationRuleRequest < Struct.new(
  :name,
  :event_type_ids,
  :resource,
  :targets,
  :detail_type,
  :client_request_token,
  :tags,
  :status)
  SENSITIVE = [:name]
  include Aws::Structure
end

#status ⇒ 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.

Returns:

  • (String) 


116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 116

class CreateNotificationRuleRequest < Struct.new(
  :name,
  :event_type_ids,
  :resource,
  :targets,
  :detail_type,
  :client_request_token,
  :tags,
  :status)
  SENSITIVE = [:name]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of tags to apply to this notification rule. Key names cannot start with "aws".

Returns:

  • (Hash<String,String>) 


116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 116

class CreateNotificationRuleRequest < Struct.new(
  :name,
  :event_type_ids,
  :resource,
  :targets,
  :detail_type,
  :client_request_token,
  :tags,
  :status)
  SENSITIVE = [:name]
  include Aws::Structure
end

#targets ⇒ Array<Types::Target>

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Amazon Q Developer in chat applications clients to associate with the notification rule.

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 116

class CreateNotificationRuleRequest < Struct.new(
  :name,
  :event_type_ids,
  :resource,
  :targets,
  :detail_type,
  :client_request_token,
  :tags,
  :status)
  SENSITIVE = [:name]
  include Aws::Structure
end