Skip to content

Latest commit

 

History

History
460 lines (286 loc) · 17.4 KB

provider.csharp.md

File metadata and controls

460 lines (286 loc) · 17.4 KB
Raw

provider

Refer to the Terraform Registory for docs: opsgenie.

provider Submodule

Constructs

OpsgenieProvider

Represents a {@link https://registry.terraform.io/providers/opsgenie/opsgenie/0.6.33/docs opsgenie}.

Initializers 

using HashiCorp.Cdktf.Providers.Opsgenie;

new OpsgenieProvider(Construct Scope, string Id, OpsgenieProviderConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config OpsgenieProviderConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigRequired

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.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
ResetAlias No description.
ResetApiUrl No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • 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.

ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

ResetAlias 
private void ResetAlias()
ResetApiUrl 
private void ResetApiUrl()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformProvider No description.
IsConstruct 
using HashiCorp.Cdktf.Providers.Opsgenie;

OpsgenieProvider.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.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Opsgenie;

OpsgenieProvider.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformProvider 
using HashiCorp.Cdktf.Providers.Opsgenie;

OpsgenieProvider.IsTerraformProvider(object X);
XRequired
  • Type: object

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
MetaAttributes System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
TerraformProviderSource string No description.
Alias string No description.
AliasInput string No description.
ApiKeyInput string No description.
ApiUrlInput string No description.
ApiKey string No description.
ApiUrl string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
MetaAttributesRequired 
public System.Collections.Generic.IDictionary<string, object> MetaAttributes { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
TerraformProviderSourceOptional 
public string TerraformProviderSource { get; }
  • Type: string
AliasOptional 
public string Alias { get; }
  • Type: string
AliasInputOptional 
public string AliasInput { get; }
  • Type: string
ApiKeyInputOptional 
public string ApiKeyInput { get; }
  • Type: string
ApiUrlInputOptional 
public string ApiUrlInput { get; }
  • Type: string
ApiKeyOptional 
public string ApiKey { get; }
  • Type: string
ApiUrlOptional 
public string ApiUrl { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

OpsgenieProviderConfig

Initializer 

using HashiCorp.Cdktf.Providers.Opsgenie;

new OpsgenieProviderConfig {
    string ApiKey,
    string Alias = null,
    string ApiUrl = null
};

Properties

Name Type Description
ApiKey string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opsgenie/opsgenie/0.6.33/docs#api_key OpsgenieProvider#api_key}.
Alias string Alias name.
ApiUrl string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opsgenie/opsgenie/0.6.33/docs#api_url OpsgenieProvider#api_url}.
ApiKeyRequired 
public string ApiKey { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opsgenie/opsgenie/0.6.33/docs#api_key OpsgenieProvider#api_key}.

AliasOptional 
public string Alias { get; set; }
  • Type: string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opsgenie/opsgenie/0.6.33/docs#alias OpsgenieProvider#alias}

ApiUrlOptional 
public string ApiUrl { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opsgenie/opsgenie/0.6.33/docs#api_url OpsgenieProvider#api_url}.