Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
harness.platform.RepoWebhook
Explore with Pulumi AI
Resource for creating a Harness Repo Webhook.
Create RepoWebhook Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RepoWebhook(name: string, args: RepoWebhookArgs, opts?: CustomResourceOptions);
@overload
def RepoWebhook(resource_name: str,
args: RepoWebhookArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RepoWebhook(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
identifier: Optional[str] = None,
insecure: Optional[bool] = None,
repo_identifier: Optional[str] = None,
url: Optional[str] = None,
description: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
secret: Optional[str] = None,
triggers: Optional[Sequence[str]] = None)
func NewRepoWebhook(ctx *Context, name string, args RepoWebhookArgs, opts ...ResourceOption) (*RepoWebhook, error)
public RepoWebhook(string name, RepoWebhookArgs args, CustomResourceOptions? opts = null)
public RepoWebhook(String name, RepoWebhookArgs args)
public RepoWebhook(String name, RepoWebhookArgs args, CustomResourceOptions options)
type: harness:platform:RepoWebhook
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 RepoWebhookArgs
- 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 RepoWebhookArgs
- 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 RepoWebhookArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RepoWebhookArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RepoWebhookArgs
- 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 repoWebhookResource = new Harness.Platform.RepoWebhook("repoWebhookResource", new()
{
Enabled = false,
Identifier = "string",
Insecure = false,
RepoIdentifier = "string",
Url = "string",
Description = "string",
OrgId = "string",
ProjectId = "string",
Secret = "string",
Triggers = new[]
{
"string",
},
});
example, err := platform.NewRepoWebhook(ctx, "repoWebhookResource", &platform.RepoWebhookArgs{
Enabled: pulumi.Bool(false),
Identifier: pulumi.String("string"),
Insecure: pulumi.Bool(false),
RepoIdentifier: pulumi.String("string"),
Url: pulumi.String("string"),
Description: pulumi.String("string"),
OrgId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Secret: pulumi.String("string"),
Triggers: pulumi.StringArray{
pulumi.String("string"),
},
})
var repoWebhookResource = new RepoWebhook("repoWebhookResource", RepoWebhookArgs.builder()
.enabled(false)
.identifier("string")
.insecure(false)
.repoIdentifier("string")
.url("string")
.description("string")
.orgId("string")
.projectId("string")
.secret("string")
.triggers("string")
.build());
repo_webhook_resource = harness.platform.RepoWebhook("repoWebhookResource",
enabled=False,
identifier="string",
insecure=False,
repo_identifier="string",
url="string",
description="string",
org_id="string",
project_id="string",
secret="string",
triggers=["string"])
const repoWebhookResource = new harness.platform.RepoWebhook("repoWebhookResource", {
enabled: false,
identifier: "string",
insecure: false,
repoIdentifier: "string",
url: "string",
description: "string",
orgId: "string",
projectId: "string",
secret: "string",
triggers: ["string"],
});
type: harness:platform:RepoWebhook
properties:
description: string
enabled: false
identifier: string
insecure: false
orgId: string
projectId: string
repoIdentifier: string
secret: string
triggers:
- string
url: string
RepoWebhook Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The RepoWebhook resource accepts the following input properties:
- Enabled bool
- Webhook enabled.
- Identifier string
- Identifier of the webhook.
- Insecure bool
- Allow insecure connections for provided webhook URL.
- Repo
Identifier string - Identifier of the repository.
- Url string
- URL that's called by the webhook.
- Description string
- Description of the webhook.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- Secret string
- Webhook secret which will be used to sign the webhook payload.
- Triggers List<string>
- List of triggers of the webhook (keep empty for all triggers).
- Enabled bool
- Webhook enabled.
- Identifier string
- Identifier of the webhook.
- Insecure bool
- Allow insecure connections for provided webhook URL.
- Repo
Identifier string - Identifier of the repository.
- Url string
- URL that's called by the webhook.
- Description string
- Description of the webhook.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- Secret string
- Webhook secret which will be used to sign the webhook payload.
- Triggers []string
- List of triggers of the webhook (keep empty for all triggers).
- enabled Boolean
- Webhook enabled.
- identifier String
- Identifier of the webhook.
- insecure Boolean
- Allow insecure connections for provided webhook URL.
- repo
Identifier String - Identifier of the repository.
- url String
- URL that's called by the webhook.
- description String
- Description of the webhook.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- secret String
- Webhook secret which will be used to sign the webhook payload.
- triggers List<String>
- List of triggers of the webhook (keep empty for all triggers).
- enabled boolean
- Webhook enabled.
- identifier string
- Identifier of the webhook.
- insecure boolean
- Allow insecure connections for provided webhook URL.
- repo
Identifier string - Identifier of the repository.
- url string
- URL that's called by the webhook.
- description string
- Description of the webhook.
- org
Id string - Unique identifier of the organization.
- project
Id string - Unique identifier of the project.
- secret string
- Webhook secret which will be used to sign the webhook payload.
- triggers string[]
- List of triggers of the webhook (keep empty for all triggers).
- enabled bool
- Webhook enabled.
- identifier str
- Identifier of the webhook.
- insecure bool
- Allow insecure connections for provided webhook URL.
- repo_
identifier str - Identifier of the repository.
- url str
- URL that's called by the webhook.
- description str
- Description of the webhook.
- org_
id str - Unique identifier of the organization.
- project_
id str - Unique identifier of the project.
- secret str
- Webhook secret which will be used to sign the webhook payload.
- triggers Sequence[str]
- List of triggers of the webhook (keep empty for all triggers).
- enabled Boolean
- Webhook enabled.
- identifier String
- Identifier of the webhook.
- insecure Boolean
- Allow insecure connections for provided webhook URL.
- repo
Identifier String - Identifier of the repository.
- url String
- URL that's called by the webhook.
- description String
- Description of the webhook.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- secret String
- Webhook secret which will be used to sign the webhook payload.
- triggers List<String>
- List of triggers of the webhook (keep empty for all triggers).
Outputs
All input properties are implicitly available as output properties. Additionally, the RepoWebhook resource produces the following output properties:
- created int
- Timestamp when the webhook was created.
- created_
by int - ID of the user who created the webhook.
- has_
secret bool - Created webhook has secret encoding.
- id str
- The provider-assigned unique ID for this managed resource.
Look up Existing RepoWebhook Resource
Get an existing RepoWebhook 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?: RepoWebhookState, opts?: CustomResourceOptions): RepoWebhook
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created: Optional[int] = None,
created_by: Optional[int] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
has_secret: Optional[bool] = None,
identifier: Optional[str] = None,
insecure: Optional[bool] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
repo_identifier: Optional[str] = None,
secret: Optional[str] = None,
triggers: Optional[Sequence[str]] = None,
url: Optional[str] = None) -> RepoWebhook
func GetRepoWebhook(ctx *Context, name string, id IDInput, state *RepoWebhookState, opts ...ResourceOption) (*RepoWebhook, error)
public static RepoWebhook Get(string name, Input<string> id, RepoWebhookState? state, CustomResourceOptions? opts = null)
public static RepoWebhook get(String name, Output<String> id, RepoWebhookState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Created int
- Timestamp when the webhook was created.
- Created
By int - ID of the user who created the webhook.
- Description string
- Description of the webhook.
- Enabled bool
- Webhook enabled.
- Has
Secret bool - Created webhook has secret encoding.
- Identifier string
- Identifier of the webhook.
- Insecure bool
- Allow insecure connections for provided webhook URL.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- Repo
Identifier string - Identifier of the repository.
- Secret string
- Webhook secret which will be used to sign the webhook payload.
- Triggers List<string>
- List of triggers of the webhook (keep empty for all triggers).
- Url string
- URL that's called by the webhook.
- Created int
- Timestamp when the webhook was created.
- Created
By int - ID of the user who created the webhook.
- Description string
- Description of the webhook.
- Enabled bool
- Webhook enabled.
- Has
Secret bool - Created webhook has secret encoding.
- Identifier string
- Identifier of the webhook.
- Insecure bool
- Allow insecure connections for provided webhook URL.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- Repo
Identifier string - Identifier of the repository.
- Secret string
- Webhook secret which will be used to sign the webhook payload.
- Triggers []string
- List of triggers of the webhook (keep empty for all triggers).
- Url string
- URL that's called by the webhook.
- created Integer
- Timestamp when the webhook was created.
- created
By Integer - ID of the user who created the webhook.
- description String
- Description of the webhook.
- enabled Boolean
- Webhook enabled.
- has
Secret Boolean - Created webhook has secret encoding.
- identifier String
- Identifier of the webhook.
- insecure Boolean
- Allow insecure connections for provided webhook URL.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- repo
Identifier String - Identifier of the repository.
- secret String
- Webhook secret which will be used to sign the webhook payload.
- triggers List<String>
- List of triggers of the webhook (keep empty for all triggers).
- url String
- URL that's called by the webhook.
- created number
- Timestamp when the webhook was created.
- created
By number - ID of the user who created the webhook.
- description string
- Description of the webhook.
- enabled boolean
- Webhook enabled.
- has
Secret boolean - Created webhook has secret encoding.
- identifier string
- Identifier of the webhook.
- insecure boolean
- Allow insecure connections for provided webhook URL.
- org
Id string - Unique identifier of the organization.
- project
Id string - Unique identifier of the project.
- repo
Identifier string - Identifier of the repository.
- secret string
- Webhook secret which will be used to sign the webhook payload.
- triggers string[]
- List of triggers of the webhook (keep empty for all triggers).
- url string
- URL that's called by the webhook.
- created int
- Timestamp when the webhook was created.
- created_
by int - ID of the user who created the webhook.
- description str
- Description of the webhook.
- enabled bool
- Webhook enabled.
- has_
secret bool - Created webhook has secret encoding.
- identifier str
- Identifier of the webhook.
- insecure bool
- Allow insecure connections for provided webhook URL.
- org_
id str - Unique identifier of the organization.
- project_
id str - Unique identifier of the project.
- repo_
identifier str - Identifier of the repository.
- secret str
- Webhook secret which will be used to sign the webhook payload.
- triggers Sequence[str]
- List of triggers of the webhook (keep empty for all triggers).
- url str
- URL that's called by the webhook.
- created Number
- Timestamp when the webhook was created.
- created
By Number - ID of the user who created the webhook.
- description String
- Description of the webhook.
- enabled Boolean
- Webhook enabled.
- has
Secret Boolean - Created webhook has secret encoding.
- identifier String
- Identifier of the webhook.
- insecure Boolean
- Allow insecure connections for provided webhook URL.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- repo
Identifier String - Identifier of the repository.
- secret String
- Webhook secret which will be used to sign the webhook payload.
- triggers List<String>
- List of triggers of the webhook (keep empty for all triggers).
- url String
- URL that's called by the webhook.
Package Details
- Repository
- harness pulumi/pulumi-harness
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
harness
Terraform Provider.