`organizationWebhook` Submodule

Constructs

OrganizationWebhook

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook github_organization_webhook}.

Initializers

using HashiCorp.Cdktf.Providers.Github;

new OrganizationWebhook(Construct Scope, string Id, OrganizationWebhookConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`OrganizationWebhookConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`Id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`Config`^Required

Type: OrganizationWebhookConfig

Methods

Name	Description
`ToString`	Returns a string representation of this construct.
`AddOverride`	No description.
`OverrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`ResetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`ToHclTerraform`	No description.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`AddMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`HasResourceMove`	No description.
`ImportFrom`	No description.
`InterpolationForAttribute`	No description.
`MoveFromId`	Move the resource corresponding to "id" to this resource.
`MoveTo`	Moves this resource to the target resource given by moveTarget.
`MoveToId`	Moves this resource to the resource corresponding to "id".
`PutConfiguration`	No description.
`ResetActive`	No description.
`ResetConfiguration`	No description.
`ResetId`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`Id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`MoveTo`

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

`MoveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`Index`^Optional

Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`MoveToId`

private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

`Id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`PutConfiguration`

private void PutConfiguration(OrganizationWebhookConfiguration Value)

`Value`^Required

Type: OrganizationWebhookConfiguration

`ResetActive`

private void ResetActive()

`ResetConfiguration`

private void ResetConfiguration()

`ResetId`

private void ResetId()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a OrganizationWebhook resource upon running "cdktf plan ".

`IsConstruct`

using HashiCorp.Cdktf.Providers.Github;

OrganizationWebhook.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Github;

OrganizationWebhook.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Github;

OrganizationWebhook.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Github;

OrganizationWebhook.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a OrganizationWebhook resource upon running "cdktf plan ".

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`ImportToId`^Required

Type: string

The construct id used in the generated config for the OrganizationWebhook to import.

`ImportFromId`^Required

Type: string

The id of the existing OrganizationWebhook that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#import import section} in the documentation of this resource for the id to use

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the OrganizationWebhook to import is found.

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`HashiCorp.Cdktf.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Configuration`	`OrganizationWebhookConfigurationOutputReference`	No description.
`Etag`	`string`	No description.
`Url`	`string`	No description.
`ActiveInput`	`object`	No description.
`ConfigurationInput`	`OrganizationWebhookConfiguration`	No description.
`EventsInput`	`string[]`	No description.
`IdInput`	`string`	No description.
`Active`	`object`	No description.
`Events`	`string[]`	No description.
`Id`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`Configuration`^Required

public OrganizationWebhookConfigurationOutputReference Configuration { get; }

Type: OrganizationWebhookConfigurationOutputReference

`Etag`^Required

public string Etag { get; }

Type: string

`Url`^Required

public string Url { get; }

Type: string

`ActiveInput`^Optional

public object ActiveInput { get; }

Type: object

`ConfigurationInput`^Optional

public OrganizationWebhookConfiguration ConfigurationInput { get; }

Type: OrganizationWebhookConfiguration

`EventsInput`^Optional

public string[] EventsInput { get; }

Type: string[]

`IdInput`^Optional

public string IdInput { get; }

Type: string

`Active`^Required

public object Active { get; }

Type: object

`Events`^Required

public string[] Events { get; }

Type: string[]

`Id`^Required

public string Id { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

OrganizationWebhookConfig

Initializer

using HashiCorp.Cdktf.Providers.Github;

new OrganizationWebhookConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string[] Events,
    object Active = null,
    OrganizationWebhookConfiguration Configuration = null,
    string Id = null
};

Properties

Name	Type	Description
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`HashiCorp.Cdktf.ITerraformDependable[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Events`	`string[]`	A list of events which should trigger the webhook.
`Active`	`object`	Indicate if the webhook should receive events.
`Configuration`	`OrganizationWebhookConfiguration`	configuration block.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#id OrganizationWebhook#id}.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`Events`^Required

public string[] Events { get; set; }

Type: string[]

A list of events which should trigger the webhook.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#events OrganizationWebhook#events}

`Active`^Optional

public object Active { get; set; }

Type: object

Indicate if the webhook should receive events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#active OrganizationWebhook#active}

`Configuration`^Optional

public OrganizationWebhookConfiguration Configuration { get; set; }

Type: OrganizationWebhookConfiguration

configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#configuration OrganizationWebhook#configuration}

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#id OrganizationWebhook#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

OrganizationWebhookConfiguration

Initializer

using HashiCorp.Cdktf.Providers.Github;

new OrganizationWebhookConfiguration {
    string Url,
    string ContentType = null,
    object InsecureSsl = null,
    string Secret = null
};

Properties

Name	Type	Description
`Url`	`string`	The URL of the webhook.
`ContentType`	`string`	The content type for the payload. Valid values are either 'form' or 'json'.
`InsecureSsl`	`object`	Insecure SSL boolean toggle. Defaults to 'false'.
`Secret`	`string`	The shared secret for the webhook.

`Url`^Required

public string Url { get; set; }

Type: string

The URL of the webhook.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#url OrganizationWebhook#url}

`ContentType`^Optional

public string ContentType { get; set; }

Type: string

The content type for the payload. Valid values are either 'form' or 'json'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#content_type OrganizationWebhook#content_type}

`InsecureSsl`^Optional

public object InsecureSsl { get; set; }

Type: object

Insecure SSL boolean toggle. Defaults to 'false'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#insecure_ssl OrganizationWebhook#insecure_ssl}

`Secret`^Optional

public string Secret { get; set; }

Type: string

The shared secret for the webhook.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.5.0/docs/resources/organization_webhook#secret OrganizationWebhook#secret}

Classes

OrganizationWebhookConfigurationOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Github;

new OrganizationWebhookConfigurationOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`ComputeFqn`	No description.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetContentType`	No description.
`ResetInsecureSsl`	No description.
`ResetSecret`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetContentType`

private void ResetContentType()

`ResetInsecureSsl`

private void ResetInsecureSsl()

`ResetSecret`

private void ResetSecret()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`ContentTypeInput`	`string`	No description.
`InsecureSslInput`	`object`	No description.
`SecretInput`	`string`	No description.
`UrlInput`	`string`	No description.
`ContentType`	`string`	No description.
`InsecureSsl`	`object`	No description.
`Secret`	`string`	No description.
`Url`	`string`	No description.
`InternalValue`	`OrganizationWebhookConfiguration`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`ContentTypeInput`^Optional

public string ContentTypeInput { get; }

Type: string

`InsecureSslInput`^Optional

public object InsecureSslInput { get; }

Type: object

`SecretInput`^Optional

public string SecretInput { get; }

Type: string

`UrlInput`^Optional

public string UrlInput { get; }

Type: string

`ContentType`^Required

public string ContentType { get; }

Type: string

`InsecureSsl`^Required

public object InsecureSsl { get; }

Type: object

`Secret`^Required

public string Secret { get; }

Type: string

`Url`^Required

public string Url { get; }

Type: string

`InternalValue`^Optional

public OrganizationWebhookConfiguration InternalValue { get; }

Type: OrganizationWebhookConfiguration

Files

organizationWebhook.csharp.md

Latest commit

History

organizationWebhook.csharp.md

File metadata and controls

organizationWebhook Submodule

Constructs