harness.platform.PipelineCentralNotificationRule
Resource for creating a Harness Notification Rule for Pipeline
Create PipelineCentralNotificationRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PipelineCentralNotificationRule(name: string, args: PipelineCentralNotificationRuleArgs, opts?: CustomResourceOptions);
@overload
def PipelineCentralNotificationRule(resource_name: str,
args: PipelineCentralNotificationRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PipelineCentralNotificationRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
identifier: Optional[str] = None,
notification_channel_refs: Optional[Sequence[str]] = None,
notification_conditions: Optional[Sequence[PipelineCentralNotificationRuleNotificationConditionArgs]] = None,
custom_notification_template_ref: Optional[PipelineCentralNotificationRuleCustomNotificationTemplateRefArgs] = None,
name: Optional[str] = None,
org: Optional[str] = None,
project: Optional[str] = None,
status: Optional[str] = None)
func NewPipelineCentralNotificationRule(ctx *Context, name string, args PipelineCentralNotificationRuleArgs, opts ...ResourceOption) (*PipelineCentralNotificationRule, error)
public PipelineCentralNotificationRule(string name, PipelineCentralNotificationRuleArgs args, CustomResourceOptions? opts = null)
public PipelineCentralNotificationRule(String name, PipelineCentralNotificationRuleArgs args)
public PipelineCentralNotificationRule(String name, PipelineCentralNotificationRuleArgs args, CustomResourceOptions options)
type: harness:platform:PipelineCentralNotificationRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PipelineCentralNotificationRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PipelineCentralNotificationRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PipelineCentralNotificationRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PipelineCentralNotificationRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PipelineCentralNotificationRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var pipelineCentralNotificationRuleResource = new Harness.Platform.PipelineCentralNotificationRule("pipelineCentralNotificationRuleResource", new()
{
Identifier = "string",
NotificationChannelRefs = new[]
{
"string",
},
NotificationConditions = new[]
{
new Harness.Platform.Inputs.PipelineCentralNotificationRuleNotificationConditionArgs
{
ConditionName = "string",
NotificationEventConfigs = new[]
{
new Harness.Platform.Inputs.PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigArgs
{
NotificationEntity = "string",
NotificationEvent = "string",
EntityIdentifiers = new[]
{
"string",
},
NotificationEventDatas = new[]
{
new Harness.Platform.Inputs.PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigNotificationEventDataArgs
{
ScopeIdentifiers = new[]
{
"string",
},
Type = "string",
},
},
},
},
},
},
CustomNotificationTemplateRef = new Harness.Platform.Inputs.PipelineCentralNotificationRuleCustomNotificationTemplateRefArgs
{
TemplateRef = "string",
VersionLabel = "string",
Variables = new[]
{
new Harness.Platform.Inputs.PipelineCentralNotificationRuleCustomNotificationTemplateRefVariableArgs
{
Name = "string",
Value = "string",
Type = "string",
},
},
},
Name = "string",
Org = "string",
Project = "string",
Status = "string",
});
example, err := platform.NewPipelineCentralNotificationRule(ctx, "pipelineCentralNotificationRuleResource", &platform.PipelineCentralNotificationRuleArgs{
Identifier: pulumi.String("string"),
NotificationChannelRefs: pulumi.StringArray{
pulumi.String("string"),
},
NotificationConditions: platform.PipelineCentralNotificationRuleNotificationConditionArray{
&platform.PipelineCentralNotificationRuleNotificationConditionArgs{
ConditionName: pulumi.String("string"),
NotificationEventConfigs: platform.PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigArray{
&platform.PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigArgs{
NotificationEntity: pulumi.String("string"),
NotificationEvent: pulumi.String("string"),
EntityIdentifiers: pulumi.StringArray{
pulumi.String("string"),
},
NotificationEventDatas: platform.PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigNotificationEventDataArray{
&platform.PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigNotificationEventDataArgs{
ScopeIdentifiers: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
},
},
},
},
},
},
CustomNotificationTemplateRef: &platform.PipelineCentralNotificationRuleCustomNotificationTemplateRefArgs{
TemplateRef: pulumi.String("string"),
VersionLabel: pulumi.String("string"),
Variables: platform.PipelineCentralNotificationRuleCustomNotificationTemplateRefVariableArray{
&platform.PipelineCentralNotificationRuleCustomNotificationTemplateRefVariableArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
Org: pulumi.String("string"),
Project: pulumi.String("string"),
Status: pulumi.String("string"),
})
var pipelineCentralNotificationRuleResource = new PipelineCentralNotificationRule("pipelineCentralNotificationRuleResource", PipelineCentralNotificationRuleArgs.builder()
.identifier("string")
.notificationChannelRefs("string")
.notificationConditions(PipelineCentralNotificationRuleNotificationConditionArgs.builder()
.conditionName("string")
.notificationEventConfigs(PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigArgs.builder()
.notificationEntity("string")
.notificationEvent("string")
.entityIdentifiers("string")
.notificationEventDatas(PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigNotificationEventDataArgs.builder()
.scopeIdentifiers("string")
.type("string")
.build())
.build())
.build())
.customNotificationTemplateRef(PipelineCentralNotificationRuleCustomNotificationTemplateRefArgs.builder()
.templateRef("string")
.versionLabel("string")
.variables(PipelineCentralNotificationRuleCustomNotificationTemplateRefVariableArgs.builder()
.name("string")
.value("string")
.type("string")
.build())
.build())
.name("string")
.org("string")
.project("string")
.status("string")
.build());
pipeline_central_notification_rule_resource = harness.platform.PipelineCentralNotificationRule("pipelineCentralNotificationRuleResource",
identifier="string",
notification_channel_refs=["string"],
notification_conditions=[{
"condition_name": "string",
"notification_event_configs": [{
"notification_entity": "string",
"notification_event": "string",
"entity_identifiers": ["string"],
"notification_event_datas": [{
"scope_identifiers": ["string"],
"type": "string",
}],
}],
}],
custom_notification_template_ref={
"template_ref": "string",
"version_label": "string",
"variables": [{
"name": "string",
"value": "string",
"type": "string",
}],
},
name="string",
org="string",
project="string",
status="string")
const pipelineCentralNotificationRuleResource = new harness.platform.PipelineCentralNotificationRule("pipelineCentralNotificationRuleResource", {
identifier: "string",
notificationChannelRefs: ["string"],
notificationConditions: [{
conditionName: "string",
notificationEventConfigs: [{
notificationEntity: "string",
notificationEvent: "string",
entityIdentifiers: ["string"],
notificationEventDatas: [{
scopeIdentifiers: ["string"],
type: "string",
}],
}],
}],
customNotificationTemplateRef: {
templateRef: "string",
versionLabel: "string",
variables: [{
name: "string",
value: "string",
type: "string",
}],
},
name: "string",
org: "string",
project: "string",
status: "string",
});
type: harness:platform:PipelineCentralNotificationRule
properties:
customNotificationTemplateRef:
templateRef: string
variables:
- name: string
type: string
value: string
versionLabel: string
identifier: string
name: string
notificationChannelRefs:
- string
notificationConditions:
- conditionName: string
notificationEventConfigs:
- entityIdentifiers:
- string
notificationEntity: string
notificationEvent: string
notificationEventDatas:
- scopeIdentifiers:
- string
type: string
org: string
project: string
status: string
PipelineCentralNotificationRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PipelineCentralNotificationRule resource accepts the following input properties:
- identifier String
- notification
Channel List<String>Refs - notification
Conditions List<Property Map> - custom
Notification Property MapTemplate Ref - name String
- org String
- project String
- status String
Outputs
All input properties are implicitly available as output properties. Additionally, the PipelineCentralNotificationRule resource produces the following output properties:
- Account string
- Account identifier associated with this notification channel.
- Created int
- Timestamp when the notification rule was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified int - Timestamp when the notification rule was last modified.
- Account string
- Account identifier associated with this notification channel.
- Created int
- Timestamp when the notification rule was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified int - Timestamp when the notification rule was last modified.
- account String
- Account identifier associated with this notification channel.
- created Integer
- Timestamp when the notification rule was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified Integer - Timestamp when the notification rule was last modified.
- account string
- Account identifier associated with this notification channel.
- created number
- Timestamp when the notification rule was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified number - Timestamp when the notification rule was last modified.
- account str
- Account identifier associated with this notification channel.
- created int
- Timestamp when the notification rule was created.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified int - Timestamp when the notification rule was last modified.
- account String
- Account identifier associated with this notification channel.
- created Number
- Timestamp when the notification rule was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified Number - Timestamp when the notification rule was last modified.
Look up Existing PipelineCentralNotificationRule Resource
Get an existing PipelineCentralNotificationRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PipelineCentralNotificationRuleState, opts?: CustomResourceOptions): PipelineCentralNotificationRule
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account: Optional[str] = None,
created: Optional[int] = None,
custom_notification_template_ref: Optional[PipelineCentralNotificationRuleCustomNotificationTemplateRefArgs] = None,
identifier: Optional[str] = None,
last_modified: Optional[int] = None,
name: Optional[str] = None,
notification_channel_refs: Optional[Sequence[str]] = None,
notification_conditions: Optional[Sequence[PipelineCentralNotificationRuleNotificationConditionArgs]] = None,
org: Optional[str] = None,
project: Optional[str] = None,
status: Optional[str] = None) -> PipelineCentralNotificationRule
func GetPipelineCentralNotificationRule(ctx *Context, name string, id IDInput, state *PipelineCentralNotificationRuleState, opts ...ResourceOption) (*PipelineCentralNotificationRule, error)
public static PipelineCentralNotificationRule Get(string name, Input<string> id, PipelineCentralNotificationRuleState? state, CustomResourceOptions? opts = null)
public static PipelineCentralNotificationRule get(String name, Output<String> id, PipelineCentralNotificationRuleState state, CustomResourceOptions options)
resources: _: type: harness:platform:PipelineCentralNotificationRule get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account string
- Account identifier associated with this notification channel.
- Created int
- Timestamp when the notification rule was created.
- Custom
Notification PipelineTemplate Ref Central Notification Rule Custom Notification Template Ref - Identifier string
- Last
Modified int - Timestamp when the notification rule was last modified.
- Name string
- Notification
Channel List<string>Refs - Notification
Conditions List<PipelineCentral Notification Rule Notification Condition> - Org string
- Project string
- Status string
- Account string
- Account identifier associated with this notification channel.
- Created int
- Timestamp when the notification rule was created.
- Custom
Notification PipelineTemplate Ref Central Notification Rule Custom Notification Template Ref Args - Identifier string
- Last
Modified int - Timestamp when the notification rule was last modified.
- Name string
- Notification
Channel []stringRefs - Notification
Conditions []PipelineCentral Notification Rule Notification Condition Args - Org string
- Project string
- Status string
- account String
- Account identifier associated with this notification channel.
- created Integer
- Timestamp when the notification rule was created.
- custom
Notification PipelineTemplate Ref Central Notification Rule Custom Notification Template Ref - identifier String
- last
Modified Integer - Timestamp when the notification rule was last modified.
- name String
- notification
Channel List<String>Refs - notification
Conditions List<PipelineCentral Notification Rule Notification Condition> - org String
- project String
- status String
- account string
- Account identifier associated with this notification channel.
- created number
- Timestamp when the notification rule was created.
- custom
Notification PipelineTemplate Ref Central Notification Rule Custom Notification Template Ref - identifier string
- last
Modified number - Timestamp when the notification rule was last modified.
- name string
- notification
Channel string[]Refs - notification
Conditions PipelineCentral Notification Rule Notification Condition[] - org string
- project string
- status string
- account str
- Account identifier associated with this notification channel.
- created int
- Timestamp when the notification rule was created.
- custom_
notification_ Pipelinetemplate_ ref Central Notification Rule Custom Notification Template Ref Args - identifier str
- last_
modified int - Timestamp when the notification rule was last modified.
- name str
- notification_
channel_ Sequence[str]refs - notification_
conditions Sequence[PipelineCentral Notification Rule Notification Condition Args] - org str
- project str
- status str
- account String
- Account identifier associated with this notification channel.
- created Number
- Timestamp when the notification rule was created.
- custom
Notification Property MapTemplate Ref - identifier String
- last
Modified Number - Timestamp when the notification rule was last modified.
- name String
- notification
Channel List<String>Refs - notification
Conditions List<Property Map> - org String
- project String
- status String
Supporting Types
PipelineCentralNotificationRuleCustomNotificationTemplateRef, PipelineCentralNotificationRuleCustomNotificationTemplateRefArgs
- template
Ref String - version
Label String - variables List<Property Map>
PipelineCentralNotificationRuleCustomNotificationTemplateRefVariable, PipelineCentralNotificationRuleCustomNotificationTemplateRefVariableArgs
PipelineCentralNotificationRuleNotificationCondition, PipelineCentralNotificationRuleNotificationConditionArgs
PipelineCentralNotificationRuleNotificationConditionNotificationEventConfig, PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigArgs
- notification
Entity String - notification
Event String - entity
Identifiers List<String> - notification
Event List<Property Map>Datas
PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigNotificationEventData, PipelineCentralNotificationRuleNotificationConditionNotificationEventConfigNotificationEventDataArgs
- Scope
Identifiers List<string> - Type string
- Scope
Identifiers []string - Type string
- scope
Identifiers List<String> - type String
- scope
Identifiers string[] - type string
- scope_
identifiers Sequence[str] - type str
- scope
Identifiers List<String> - type String
Package Details
- Repository
- harness pulumi/pulumi-harness
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
harness
Terraform Provider.