Skip to content

Latest commit

 

History

History
1171 lines (732 loc) · 50.9 KB

incidentTypeCustomField.go.md

File metadata and controls

1171 lines (732 loc) · 50.9 KB

incidentTypeCustomField Submodule

Constructs

IncidentTypeCustomField

Represents a {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field pagerduty_incident_type_custom_field}.

Initializers

import "github.com/cdktf/cdktf-provider-pagerduty-go/pagerduty/v13/incidenttypecustomfield"

incidenttypecustomfield.NewIncidentTypeCustomField(scope Construct, id *string, config IncidentTypeCustomFieldConfig) IncidentTypeCustomField
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config IncidentTypeCustomFieldConfig No description.

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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.
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".
ResetDefaultValue No description.
ResetDescription No description.
ResetEnabled No description.
ResetFieldOptions No description.
ResetFieldType No description.

ToString
func ToString() *string

Returns a string representation of this construct.

AddOverride
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string

valueRequired
  • Type: interface{}

OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
func ResetOverrideLogicalId()

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

ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget
func AddMoveTarget(moveTarget *string)

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

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.


GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

HasResourceMove
func HasResourceMove() interface{}
ImportFrom
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

MoveFromId
func MoveFromId(id *string)

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.

idRequired
  • Type: *string

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


MoveTo
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

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


indexOptional
  • Type: interface{}

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


MoveToId
func MoveToId(id *string)

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

idRequired
  • Type: *string

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


ResetDefaultValue
func ResetDefaultValue()
ResetDescription
func ResetDescription()
ResetEnabled
func ResetEnabled()
ResetFieldOptions
func ResetFieldOptions()
ResetFieldType
func ResetFieldType()

Static Functions

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

IsConstruct
import "github.com/cdktf/cdktf-provider-pagerduty-go/pagerduty/v13/incidenttypecustomfield"

incidenttypecustomfield.IncidentTypeCustomField_IsConstruct(x interface{}) *bool

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: interface{}

Any object.


IsTerraformElement
import "github.com/cdktf/cdktf-provider-pagerduty-go/pagerduty/v13/incidenttypecustomfield"

incidenttypecustomfield.IncidentTypeCustomField_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformResource
import "github.com/cdktf/cdktf-provider-pagerduty-go/pagerduty/v13/incidenttypecustomfield"

incidenttypecustomfield.IncidentTypeCustomField_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-pagerduty-go/pagerduty/v13/incidenttypecustomfield"

incidenttypecustomfield.IncidentTypeCustomField_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: *string

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


importFromIdRequired
  • Type: *string

The id of the existing IncidentTypeCustomField that should be imported.

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


providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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


Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Id *string No description.
SelfAttribute *string No description.
Summary *string No description.
Type *string No description.
DataTypeInput *string No description.
DefaultValueInput *string No description.
DescriptionInput *string No description.
DisplayNameInput *string No description.
EnabledInput interface{} No description.
FieldOptionsInput *[]*string No description.
FieldTypeInput *string No description.
IncidentTypeInput *string No description.
NameInput *string No description.
DataType *string No description.
DefaultValue *string No description.
Description *string No description.
DisplayName *string No description.
Enabled interface{} No description.
FieldOptions *[]*string No description.
FieldType *string No description.
IncidentType *string No description.
Name *string No description.

NodeRequired
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.


CdktfStackRequired
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

FqnRequired
func Fqn() *string
  • Type: *string

FriendlyUniqueIdRequired
func FriendlyUniqueId() *string
  • Type: *string

TerraformMetaArgumentsRequired
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}

TerraformResourceTypeRequired
func TerraformResourceType() *string
  • Type: *string

TerraformGeneratorMetadataOptional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
func Connection() interface{}
  • Type: interface{}

CountOptional
func Count() interface{}
  • Type: interface{}

DependsOnOptional
func DependsOn() *[]*string
  • Type: *[]*string

ForEachOptional
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
func Provisioners() *[]interface{}
  • Type: *[]interface{}

IdRequired
func Id() *string
  • Type: *string

SelfAttributeRequired
func SelfAttribute() *string
  • Type: *string

SummaryRequired
func Summary() *string
  • Type: *string

TypeRequired
func Type() *string
  • Type: *string

DataTypeInputOptional
func DataTypeInput() *string
  • Type: *string

DefaultValueInputOptional
func DefaultValueInput() *string
  • Type: *string

DescriptionInputOptional
func DescriptionInput() *string
  • Type: *string

DisplayNameInputOptional
func DisplayNameInput() *string
  • Type: *string

EnabledInputOptional
func EnabledInput() interface{}
  • Type: interface{}

FieldOptionsInputOptional
func FieldOptionsInput() *[]*string
  • Type: *[]*string

FieldTypeInputOptional
func FieldTypeInput() *string
  • Type: *string

IncidentTypeInputOptional
func IncidentTypeInput() *string
  • Type: *string

NameInputOptional
func NameInput() *string
  • Type: *string

DataTypeRequired
func DataType() *string
  • Type: *string

DefaultValueRequired
func DefaultValue() *string
  • Type: *string

DescriptionRequired
func Description() *string
  • Type: *string

DisplayNameRequired
func DisplayName() *string
  • Type: *string

EnabledRequired
func Enabled() interface{}
  • Type: interface{}

FieldOptionsRequired
func FieldOptions() *[]*string
  • Type: *[]*string

FieldTypeRequired
func FieldType() *string
  • Type: *string

IncidentTypeRequired
func IncidentType() *string
  • Type: *string

NameRequired
func Name() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

IncidentTypeCustomFieldConfig

Initializer

import "github.com/cdktf/cdktf-provider-pagerduty-go/pagerduty/v13/incidenttypecustomfield"

&incidenttypecustomfield.IncidentTypeCustomFieldConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	DataType: *string,
	DisplayName: *string,
	IncidentType: *string,
	Name: *string,
	DefaultValue: *string,
	Description: *string,
	Enabled: interface{},
	FieldOptions: *[]*string,
	FieldType: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
DataType *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#data_type IncidentTypeCustomField#data_type}.
DisplayName *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#display_name IncidentTypeCustomField#display_name}.
IncidentType *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#incident_type IncidentTypeCustomField#incident_type}.
Name *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#name IncidentTypeCustomField#name}.
DefaultValue *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#default_value IncidentTypeCustomField#default_value}.
Description *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#description IncidentTypeCustomField#description}.
Enabled interface{} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#enabled IncidentTypeCustomField#enabled}.
FieldOptions *[]*string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#field_options IncidentTypeCustomField#field_options}.
FieldType *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#field_type IncidentTypeCustomField#field_type}.

ConnectionOptional
Connection interface{}
  • Type: interface{}

CountOptional
Count interface{}
  • Type: interface{}

DependsOnOptional
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

ForEachOptional
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
Provisioners *[]interface{}
  • Type: *[]interface{}

DataTypeRequired
DataType *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#data_type IncidentTypeCustomField#data_type}.


DisplayNameRequired
DisplayName *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#display_name IncidentTypeCustomField#display_name}.


IncidentTypeRequired
IncidentType *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#incident_type IncidentTypeCustomField#incident_type}.


NameRequired
Name *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#name IncidentTypeCustomField#name}.


DefaultValueOptional
DefaultValue *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#default_value IncidentTypeCustomField#default_value}.


DescriptionOptional
Description *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#description IncidentTypeCustomField#description}.


EnabledOptional
Enabled interface{}
  • Type: interface{}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#enabled IncidentTypeCustomField#enabled}.


FieldOptionsOptional
FieldOptions *[]*string
  • Type: *[]*string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#field_options IncidentTypeCustomField#field_options}.


FieldTypeOptional
FieldType *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/resources/incident_type_custom_field#field_type IncidentTypeCustomField#field_type}.