`monitoringMetricDescriptor` Submodule

Constructs

MonitoringMetricDescriptor

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor google_monitoring_metric_descriptor}.

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

monitoringmetricdescriptor.NewMonitoringMetricDescriptor(scope Construct, id *string, config MonitoringMetricDescriptorConfig) MonitoringMetricDescriptor

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`	`MonitoringMetricDescriptorConfig`	No description.

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.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: MonitoringMetricDescriptorConfig

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".
`PutLabels`	No description.
`PutMetadata`	No description.
`PutTimeouts`	No description.
`ResetId`	No description.
`ResetLabels`	No description.
`ResetLaunchStage`	No description.
`ResetMetadata`	No description.
`ResetProject`	No description.
`ResetTimeouts`	No description.
`ResetUnit`	No description.

`ToString`

func ToString() *string

Returns a string representation of this construct.

`AddOverride`

func AddOverride(path *string, value interface{})

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`OverrideLogicalId`

func OverrideLogicalId(newLogicalId *string)

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`

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.

`moveTarget`^Required

Type: *string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`HasResourceMove`

func HasResourceMove() interface{}

`ImportFrom`

func ImportFrom(id *string, provider TerraformProvider)

`id`^Required

Type: *string

`provider`^Optional

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

`InterpolationForAttribute`

func InterpolationForAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

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.

`id`^Required

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.

`moveTarget`^Required

Type: *string

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

`index`^Optional

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

`id`^Required

Type: *string

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

`PutLabels`

func PutLabels(value interface{})

`value`^Required

Type: interface{}

`PutMetadata`

func PutMetadata(value MonitoringMetricDescriptorMetadata)

`value`^Required

Type: MonitoringMetricDescriptorMetadata

`PutTimeouts`

func PutTimeouts(value MonitoringMetricDescriptorTimeouts)

`value`^Required

Type: MonitoringMetricDescriptorTimeouts

`ResetId`

func ResetId()

`ResetLabels`

func ResetLabels()

`ResetLaunchStage`

func ResetLaunchStage()

`ResetMetadata`

func ResetMetadata()

`ResetProject`

func ResetProject()

`ResetTimeouts`

func ResetTimeouts()

`ResetUnit`

func ResetUnit()

Static Functions

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

`IsConstruct`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

monitoringmetricdescriptor.MonitoringMetricDescriptor_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.

`x`^Required

Type: interface{}

Any object.

`IsTerraformElement`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

monitoringmetricdescriptor.MonitoringMetricDescriptor_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

`IsTerraformResource`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

monitoringmetricdescriptor.MonitoringMetricDescriptor_IsTerraformResource(x interface{}) *bool

`x`^Required

Type: interface{}

`GenerateConfigForImport`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

monitoringmetricdescriptor.MonitoringMetricDescriptor_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

`scope`^Required

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

The scope in which to define this construct.

`importToId`^Required

Type: *string

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

`importFromId`^Required

Type: *string

The id of the existing MonitoringMetricDescriptor that should be imported.

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

`provider`^Optional

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

? Optional instance of the provider where the MonitoringMetricDescriptor 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.
`Labels`	`MonitoringMetricDescriptorLabelsList`	No description.
`Metadata`	`MonitoringMetricDescriptorMetadataOutputReference`	No description.
`MonitoredResourceTypes`	`[]string`	No description.
`Name`	`*string`	No description.
`Timeouts`	`MonitoringMetricDescriptorTimeoutsOutputReference`	No description.
`DescriptionInput`	`*string`	No description.
`DisplayNameInput`	`*string`	No description.
`IdInput`	`*string`	No description.
`LabelsInput`	`interface{}`	No description.
`LaunchStageInput`	`*string`	No description.
`MetadataInput`	`MonitoringMetricDescriptorMetadata`	No description.
`MetricKindInput`	`*string`	No description.
`ProjectInput`	`*string`	No description.
`TimeoutsInput`	`interface{}`	No description.
`TypeInput`	`*string`	No description.
`UnitInput`	`*string`	No description.
`ValueTypeInput`	`*string`	No description.
`Description`	`*string`	No description.
`DisplayName`	`*string`	No description.
`Id`	`*string`	No description.
`LaunchStage`	`*string`	No description.
`MetricKind`	`*string`	No description.
`Project`	`*string`	No description.
`Type`	`*string`	No description.
`Unit`	`*string`	No description.
`ValueType`	`*string`	No description.

`Node`^Required

func Node() Node

Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

`CdktfStack`^Required

func CdktfStack() TerraformStack

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

`Fqn`^Required

func Fqn() *string

Type: *string

`FriendlyUniqueId`^Required

func FriendlyUniqueId() *string

Type: *string

`TerraformMetaArguments`^Required

func TerraformMetaArguments() *map[string]interface{}

Type: *map[string]interface{}

`TerraformResourceType`^Required

func TerraformResourceType() *string

Type: *string

`TerraformGeneratorMetadata`^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

func Connection() interface{}

Type: interface{}

`Count`^Optional

func Count() interface{}

Type: interface{}

`DependsOn`^Optional

func DependsOn() *[]*string

Type: *[]*string

`ForEach`^Optional

func ForEach() ITerraformIterator

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

`Lifecycle`^Optional

func Lifecycle() TerraformResourceLifecycle

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

`Provider`^Optional

func Provider() TerraformProvider

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

`Provisioners`^Optional

func Provisioners() *[]interface{}

Type: *[]interface{}

`Labels`^Required

func Labels() MonitoringMetricDescriptorLabelsList

Type: MonitoringMetricDescriptorLabelsList

`Metadata`^Required

func Metadata() MonitoringMetricDescriptorMetadataOutputReference

Type: MonitoringMetricDescriptorMetadataOutputReference

`MonitoredResourceTypes`^Required

func MonitoredResourceTypes() *[]*string

Type: *[]*string

`Name`^Required

func Name() *string

Type: *string

`Timeouts`^Required

func Timeouts() MonitoringMetricDescriptorTimeoutsOutputReference

Type: MonitoringMetricDescriptorTimeoutsOutputReference

`DescriptionInput`^Optional

func DescriptionInput() *string

Type: *string

`DisplayNameInput`^Optional

func DisplayNameInput() *string

Type: *string

`IdInput`^Optional

func IdInput() *string

Type: *string

`LabelsInput`^Optional

func LabelsInput() interface{}

Type: interface{}

`LaunchStageInput`^Optional

func LaunchStageInput() *string

Type: *string

`MetadataInput`^Optional

func MetadataInput() MonitoringMetricDescriptorMetadata

Type: MonitoringMetricDescriptorMetadata

`MetricKindInput`^Optional

func MetricKindInput() *string

Type: *string

`ProjectInput`^Optional

func ProjectInput() *string

Type: *string

`TimeoutsInput`^Optional

func TimeoutsInput() interface{}

Type: interface{}

`TypeInput`^Optional

func TypeInput() *string

Type: *string

`UnitInput`^Optional

func UnitInput() *string

Type: *string

`ValueTypeInput`^Optional

func ValueTypeInput() *string

Type: *string

`Description`^Required

func Description() *string

Type: *string

`DisplayName`^Required

func DisplayName() *string

Type: *string

`Id`^Required

func Id() *string

Type: *string

`LaunchStage`^Required

func LaunchStage() *string

Type: *string

`MetricKind`^Required

func MetricKind() *string

Type: *string

`Project`^Required

func Project() *string

Type: *string

`Type`^Required

func Type() *string

Type: *string

`Unit`^Required

func Unit() *string

Type: *string

`ValueType`^Required

func ValueType() *string

Type: *string

Constants

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

`TfResourceType`^Required

func TfResourceType() *string

Type: *string

Structs

MonitoringMetricDescriptorConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

&monitoringmetricdescriptor.MonitoringMetricDescriptorConfig {
	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{},
	Description: *string,
	DisplayName: *string,
	MetricKind: *string,
	Type: *string,
	ValueType: *string,
	Id: *string,
	Labels: interface{},
	LaunchStage: *string,
	Metadata: github.com/cdktf/cdktf-provider-google-go/google/v14.monitoringMetricDescriptor.MonitoringMetricDescriptorMetadata,
	Project: *string,
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.monitoringMetricDescriptor.MonitoringMetricDescriptorTimeouts,
	Unit: *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.
`Description`	`*string`	A detailed description of the metric, which can be used in documentation.
`DisplayName`	`*string`	A concise name for the metric, which can be displayed in user interfaces.
`MetricKind`	`*string`	Whether the metric records instantaneous values, changes to a value, etc.
`Type`	`*string`	The metric type, including its DNS name prefix.
`ValueType`	`*string`	Whether the measurement is an integer, a floating-point number, etc.
`Id`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#id MonitoringMetricDescriptor#id}.
`Labels`	`interface{}`	labels block.
`LaunchStage`	`*string`	The launch stage of the metric definition. Possible values: ["LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"].
`Metadata`	`MonitoringMetricDescriptorMetadata`	metadata block.
`Project`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#project MonitoringMetricDescriptor#project}.
`Timeouts`	`MonitoringMetricDescriptorTimeouts`	timeouts block.
`Unit`	`*string`	The units in which the metric value is reported.

`Connection`^Optional

Connection interface{}

Type: interface{}

`Count`^Optional

Count interface{}

Type: interface{}

`DependsOn`^Optional

DependsOn *[]ITerraformDependable

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

`ForEach`^Optional

ForEach ITerraformIterator

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

`Lifecycle`^Optional

Lifecycle TerraformResourceLifecycle

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

`Provider`^Optional

Provider TerraformProvider

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

`Provisioners`^Optional

Provisioners *[]interface{}

Type: *[]interface{}

`Description`^Required

Description *string

Type: *string

A detailed description of the metric, which can be used in documentation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#description MonitoringMetricDescriptor#description}

`DisplayName`^Required

DisplayName *string

Type: *string

A concise name for the metric, which can be displayed in user interfaces.

Use sentence case without an ending period, for example "Request count".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#display_name MonitoringMetricDescriptor#display_name}

`MetricKind`^Required

MetricKind *string

Type: *string

Whether the metric records instantaneous values, changes to a value, etc.

Some combinations of metricKind and valueType might not be supported. Possible values: ["METRIC_KIND_UNSPECIFIED", "GAUGE", "DELTA", "CUMULATIVE"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#metric_kind MonitoringMetricDescriptor#metric_kind}

`Type`^Required

Type *string

Type: *string

The metric type, including its DNS name prefix.

The type is not URL-encoded. All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must have only upper and lower-case letters, digits, '/' and underscores '_' are allowed. Additionally, the maximum number of characters allowed for the relative_metric_name is 100. All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#type MonitoringMetricDescriptor#type}

`ValueType`^Required

ValueType *string

Type: *string

Whether the measurement is an integer, a floating-point number, etc.

Some combinations of metricKind and valueType might not be supported. Possible values: ["BOOL", "INT64", "DOUBLE", "STRING", "DISTRIBUTION"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#value_type MonitoringMetricDescriptor#value_type}

`Id`^Optional

Id *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#id MonitoringMetricDescriptor#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.

`Labels`^Optional

Labels interface{}

Type: interface{}

labels block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#labels MonitoringMetricDescriptor#labels}

`LaunchStage`^Optional

LaunchStage *string

Type: *string

The launch stage of the metric definition. Possible values: ["LAUNCH_STAGE_UNSPECIFIED", "UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#launch_stage MonitoringMetricDescriptor#launch_stage}

`Metadata`^Optional

Metadata MonitoringMetricDescriptorMetadata

Type: MonitoringMetricDescriptorMetadata

metadata block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#metadata MonitoringMetricDescriptor#metadata}

`Project`^Optional

Project *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#project MonitoringMetricDescriptor#project}.

`Timeouts`^Optional

Timeouts MonitoringMetricDescriptorTimeouts

Type: MonitoringMetricDescriptorTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#timeouts MonitoringMetricDescriptor#timeouts}

`Unit`^Optional

Unit *string

Type: *string

The units in which the metric value is reported.

It is only applicable if the valueType is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.

Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.

If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.

Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard. More info can be found in the API documentation (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#unit MonitoringMetricDescriptor#unit}

MonitoringMetricDescriptorLabels

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

&monitoringmetricdescriptor.MonitoringMetricDescriptorLabels {
	Key: *string,
	Description: *string,
	ValueType: *string,
}

Properties

Name	Type	Description
`Key`	`*string`	The key for this label.
`Description`	`*string`	A human-readable description for the label.
`ValueType`	`*string`	The type of data that can be assigned to the label. Default value: "STRING" Possible values: ["STRING", "BOOL", "INT64"].

`Key`^Required

Key *string

Type: *string

The key for this label.

The key must not exceed 100 characters. The first character of the key must be an upper- or lower-case letter, the remaining characters must be letters, digits or underscores, and the key must match the regular expression [a-zA-Z][a-zA-Z0-9_]*

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#key MonitoringMetricDescriptor#key}

`Description`^Optional

Description *string

Type: *string

A human-readable description for the label.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#description MonitoringMetricDescriptor#description}

`ValueType`^Optional

ValueType *string

Type: *string

The type of data that can be assigned to the label. Default value: "STRING" Possible values: ["STRING", "BOOL", "INT64"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#value_type MonitoringMetricDescriptor#value_type}

MonitoringMetricDescriptorMetadata

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

&monitoringmetricdescriptor.MonitoringMetricDescriptorMetadata {
	IngestDelay: *string,
	SamplePeriod: *string,
}

Properties

Name	Type	Description
`IngestDelay`	`*string`	The delay of data points caused by ingestion.
`SamplePeriod`	`*string`	The sampling period of metric data points.

`IngestDelay`^Optional

IngestDelay *string

Type: *string

The delay of data points caused by ingestion.

Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. In 'duration format'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#ingest_delay MonitoringMetricDescriptor#ingest_delay}

`SamplePeriod`^Optional

SamplePeriod *string

Type: *string

The sampling period of metric data points.

For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. In 'duration format'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#sample_period MonitoringMetricDescriptor#sample_period}

MonitoringMetricDescriptorTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

&monitoringmetricdescriptor.MonitoringMetricDescriptorTimeouts {
	Create: *string,
	Delete: *string,
	Update: *string,
}

Properties

Name	Type	Description
`Create`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#create MonitoringMetricDescriptor#create}.
`Delete`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#delete MonitoringMetricDescriptor#delete}.
`Update`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#update MonitoringMetricDescriptor#update}.

`Create`^Optional

Create *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#create MonitoringMetricDescriptor#create}.

`Delete`^Optional

Delete *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#delete MonitoringMetricDescriptor#delete}.

`Update`^Optional

Update *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/monitoring_metric_descriptor#update MonitoringMetricDescriptor#update}.

Classes

MonitoringMetricDescriptorLabelsList

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

monitoringmetricdescriptor.NewMonitoringMetricDescriptorLabelsList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) MonitoringMetricDescriptorLabelsList

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`*bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: *string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

func AllWithMapKey(mapKeyAttributeName *string) DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: *string

`ComputeFqn`

func ComputeFqn() *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

func Get(index *f64) MonitoringMetricDescriptorLabelsOutputReference

`index`^Required

Type: *f64

the index of the item to return.

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.
`InternalValue`	`interface{}`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

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

func Fqn() *string

Type: *string

`InternalValue`^Optional

func InternalValue() interface{}

Type: interface{}

MonitoringMetricDescriptorLabelsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

monitoringmetricdescriptor.NewMonitoringMetricDescriptorLabelsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) MonitoringMetricDescriptorLabelsOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`*f64`	the index of this item in the list.
`complexObjectIsFromSet`	`*bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: *string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: *f64

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

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.
`ResetDescription`	No description.
`ResetValueType`	No description.

`ComputeFqn`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetDescription`

func ResetDescription()

`ResetValueType`

func ResetValueType()

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.
`DescriptionInput`	`*string`	No description.
`KeyInput`	`*string`	No description.
`ValueTypeInput`	`*string`	No description.
`Description`	`*string`	No description.
`Key`	`*string`	No description.
`ValueType`	`*string`	No description.
`InternalValue`	`interface{}`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

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

func Fqn() *string

Type: *string

`DescriptionInput`^Optional

func DescriptionInput() *string

Type: *string

`KeyInput`^Optional

func KeyInput() *string

Type: *string

`ValueTypeInput`^Optional

func ValueTypeInput() *string

Type: *string

`Description`^Required

func Description() *string

Type: *string

`Key`^Required

func Key() *string

Type: *string

`ValueType`^Required

func ValueType() *string

Type: *string

`InternalValue`^Optional

func InternalValue() interface{}

Type: interface{}

MonitoringMetricDescriptorMetadataOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

monitoringmetricdescriptor.NewMonitoringMetricDescriptorMetadataOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) MonitoringMetricDescriptorMetadataOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/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.
`ResetIngestDelay`	No description.
`ResetSamplePeriod`	No description.

`ComputeFqn`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetIngestDelay`

func ResetIngestDelay()

`ResetSamplePeriod`

func ResetSamplePeriod()

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.
`IngestDelayInput`	`*string`	No description.
`SamplePeriodInput`	`*string`	No description.
`IngestDelay`	`*string`	No description.
`SamplePeriod`	`*string`	No description.
`InternalValue`	`MonitoringMetricDescriptorMetadata`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

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

func Fqn() *string

Type: *string

`IngestDelayInput`^Optional

func IngestDelayInput() *string

Type: *string

`SamplePeriodInput`^Optional

func SamplePeriodInput() *string

Type: *string

`IngestDelay`^Required

func IngestDelay() *string

Type: *string

`SamplePeriod`^Required

func SamplePeriod() *string

Type: *string

`InternalValue`^Optional

func InternalValue() MonitoringMetricDescriptorMetadata

Type: MonitoringMetricDescriptorMetadata

MonitoringMetricDescriptorTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/monitoringmetricdescriptor"

monitoringmetricdescriptor.NewMonitoringMetricDescriptorTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) MonitoringMetricDescriptorTimeoutsOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/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.
`ResetCreate`	No description.
`ResetDelete`	No description.
`ResetUpdate`	No description.

`ComputeFqn`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetCreate`

func ResetCreate()

`ResetDelete`

func ResetDelete()

`ResetUpdate`

func ResetUpdate()

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.
`CreateInput`	`*string`	No description.
`DeleteInput`	`*string`	No description.
`UpdateInput`	`*string`	No description.
`Create`	`*string`	No description.
`Delete`	`*string`	No description.
`Update`	`*string`	No description.
`InternalValue`	`interface{}`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

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

func Fqn() *string

Type: *string

`CreateInput`^Optional

func CreateInput() *string

Type: *string

`DeleteInput`^Optional

func DeleteInput() *string

Type: *string

`UpdateInput`^Optional

func UpdateInput() *string

Type: *string

`Create`^Required

func Create() *string

Type: *string

`Delete`^Required

func Delete() *string

Type: *string

`Update`^Required

func Update() *string

Type: *string

`InternalValue`^Optional

func InternalValue() interface{}

Type: interface{}

Files

monitoringMetricDescriptor.go.md

Latest commit

History

monitoringMetricDescriptor.go.md

File metadata and controls

monitoringMetricDescriptor Submodule

Constructs