Skip to content

Latest commit

 

History

History
1216 lines (758 loc) · 50.4 KB

integrationAzure.go.md

File metadata and controls

1216 lines (758 loc) · 50.4 KB

integrationAzure Submodule

Constructs

IntegrationAzure

Represents a {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure datadog_integration_azure}.

Initializers

import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/integrationazure"

integrationazure.NewIntegrationAzure(scope Construct, id *string, config IntegrationAzureConfig) IntegrationAzure
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 IntegrationAzureConfig 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".
ResetAppServicePlanFilters No description.
ResetAutomute No description.
ResetContainerAppFilters No description.
ResetCspmEnabled No description.
ResetCustomMetricsEnabled No description.
ResetHostFilters No description.
ResetResourceCollectionEnabled 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".


ResetAppServicePlanFilters
func ResetAppServicePlanFilters()
ResetAutomute
func ResetAutomute()
ResetContainerAppFilters
func ResetContainerAppFilters()
ResetCspmEnabled
func ResetCspmEnabled()
ResetCustomMetricsEnabled
func ResetCustomMetricsEnabled()
ResetHostFilters
func ResetHostFilters()
ResetResourceCollectionEnabled
func ResetResourceCollectionEnabled()

Static Functions

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

IsConstruct
import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/integrationazure"

integrationazure.IntegrationAzure_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-datadog-go/datadog/v11/integrationazure"

integrationazure.IntegrationAzure_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformResource
import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/integrationazure"

integrationazure.IntegrationAzure_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/integrationazure"

integrationazure.IntegrationAzure_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a IntegrationAzure 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 IntegrationAzure to import.


importFromIdRequired
  • Type: *string

The id of the existing IntegrationAzure that should be imported.

Refer to the {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#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 IntegrationAzure 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.
AppServicePlanFiltersInput *string No description.
AutomuteInput interface{} No description.
ClientIdInput *string No description.
ClientSecretInput *string No description.
ContainerAppFiltersInput *string No description.
CspmEnabledInput interface{} No description.
CustomMetricsEnabledInput interface{} No description.
HostFiltersInput *string No description.
ResourceCollectionEnabledInput interface{} No description.
TenantNameInput *string No description.
AppServicePlanFilters *string No description.
Automute interface{} No description.
ClientId *string No description.
ClientSecret *string No description.
ContainerAppFilters *string No description.
CspmEnabled interface{} No description.
CustomMetricsEnabled interface{} No description.
HostFilters *string No description.
ResourceCollectionEnabled interface{} No description.
TenantName *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

AppServicePlanFiltersInputOptional
func AppServicePlanFiltersInput() *string
  • Type: *string

AutomuteInputOptional
func AutomuteInput() interface{}
  • Type: interface{}

ClientIdInputOptional
func ClientIdInput() *string
  • Type: *string

ClientSecretInputOptional
func ClientSecretInput() *string
  • Type: *string

ContainerAppFiltersInputOptional
func ContainerAppFiltersInput() *string
  • Type: *string

CspmEnabledInputOptional
func CspmEnabledInput() interface{}
  • Type: interface{}

CustomMetricsEnabledInputOptional
func CustomMetricsEnabledInput() interface{}
  • Type: interface{}

HostFiltersInputOptional
func HostFiltersInput() *string
  • Type: *string

ResourceCollectionEnabledInputOptional
func ResourceCollectionEnabledInput() interface{}
  • Type: interface{}

TenantNameInputOptional
func TenantNameInput() *string
  • Type: *string

AppServicePlanFiltersRequired
func AppServicePlanFilters() *string
  • Type: *string

AutomuteRequired
func Automute() interface{}
  • Type: interface{}

ClientIdRequired
func ClientId() *string
  • Type: *string

ClientSecretRequired
func ClientSecret() *string
  • Type: *string

ContainerAppFiltersRequired
func ContainerAppFilters() *string
  • Type: *string

CspmEnabledRequired
func CspmEnabled() interface{}
  • Type: interface{}

CustomMetricsEnabledRequired
func CustomMetricsEnabled() interface{}
  • Type: interface{}

HostFiltersRequired
func HostFilters() *string
  • Type: *string

ResourceCollectionEnabledRequired
func ResourceCollectionEnabled() interface{}
  • Type: interface{}

TenantNameRequired
func TenantName() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

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

Structs

IntegrationAzureConfig

Initializer

import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/integrationazure"

&integrationazure.IntegrationAzureConfig {
	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{},
	ClientId: *string,
	ClientSecret: *string,
	TenantName: *string,
	AppServicePlanFilters: *string,
	Automute: interface{},
	ContainerAppFilters: *string,
	CspmEnabled: interface{},
	CustomMetricsEnabled: interface{},
	HostFilters: *string,
	ResourceCollectionEnabled: interface{},
}

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.
ClientId *string Your Azure web application ID.
ClientSecret *string (Required for Initial Creation) Your Azure web application secret key.
TenantName *string Your Azure Active Directory ID.
AppServicePlanFilters *string This comma-separated list of tags (in the form key:value,key:value) defines a filter that Datadog uses when collecting metrics from Azure App Service Plans.
Automute interface{} Silence monitors for expected Azure VM shutdowns. Defaults to false.
ContainerAppFilters *string This comma-separated list of tags (in the form key:value,key:value) defines a filter that Datadog uses when collecting metrics from Azure Container Apps.
CspmEnabled interface{} When enabled, Datadog’s Cloud Security Management product scans resource configurations monitored by this app registration.
CustomMetricsEnabled interface{} Enable custom metrics for your organization. Defaults to false.
HostFilters *string String of host tag(s) (in the form key:value,key:value) defines a filter that Datadog will use when collecting metrics from Azure.
ResourceCollectionEnabled interface{} When enabled, Datadog collects metadata and configuration info from cloud resources (such as compute instances, databases, and load balancers) monitored by this app registration.

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

ClientIdRequired
ClientId *string
  • Type: *string

Your Azure web application ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#client_id IntegrationAzure#client_id}


ClientSecretRequired
ClientSecret *string
  • Type: *string

(Required for Initial Creation) Your Azure web application secret key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#client_secret IntegrationAzure#client_secret}


TenantNameRequired
TenantName *string
  • Type: *string

Your Azure Active Directory ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#tenant_name IntegrationAzure#tenant_name}


AppServicePlanFiltersOptional
AppServicePlanFilters *string
  • Type: *string

This comma-separated list of tags (in the form key:value,key:value) defines a filter that Datadog uses when collecting metrics from Azure App Service Plans.

Only App Service Plans that match one of the defined tags are imported into Datadog. The rest, including the apps and functions running on them, are ignored. This also filters the metrics for any App or Function running on the App Service Plan(s). Defaults to "".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#app_service_plan_filters IntegrationAzure#app_service_plan_filters}


AutomuteOptional
Automute interface{}
  • Type: interface{}

Silence monitors for expected Azure VM shutdowns. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#automute IntegrationAzure#automute}


ContainerAppFiltersOptional
ContainerAppFilters *string
  • Type: *string

This comma-separated list of tags (in the form key:value,key:value) defines a filter that Datadog uses when collecting metrics from Azure Container Apps.

Only Container Apps that match one of the defined tags are imported into Datadog. Defaults to "".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#container_app_filters IntegrationAzure#container_app_filters}


CspmEnabledOptional
CspmEnabled interface{}
  • Type: interface{}

When enabled, Datadog’s Cloud Security Management product scans resource configurations monitored by this app registration.

Note: This requires resource_collection_enabled to be set to true. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#cspm_enabled IntegrationAzure#cspm_enabled}


CustomMetricsEnabledOptional
CustomMetricsEnabled interface{}
  • Type: interface{}

Enable custom metrics for your organization. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#custom_metrics_enabled IntegrationAzure#custom_metrics_enabled}


HostFiltersOptional
HostFilters *string
  • Type: *string

String of host tag(s) (in the form key:value,key:value) defines a filter that Datadog will use when collecting metrics from Azure.

Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. e.x. env:production,deploymentgroup:red Defaults to "".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#host_filters IntegrationAzure#host_filters}


ResourceCollectionEnabledOptional
ResourceCollectionEnabled interface{}
  • Type: interface{}

When enabled, Datadog collects metadata and configuration info from cloud resources (such as compute instances, databases, and load balancers) monitored by this app registration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_azure#resource_collection_enabled IntegrationAzure#resource_collection_enabled}