Skip to content

Latest commit

 

History

History
1371 lines (860 loc) · 56.8 KB

integrationAws.go.md

File metadata and controls

1371 lines (860 loc) · 56.8 KB

integrationAws Submodule

Constructs

IntegrationAws

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

Initializers

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

integrationaws.NewIntegrationAws(scope Construct, id *string, config IntegrationAwsConfig) IntegrationAws
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 IntegrationAwsConfig 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


configOptional

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".
ResetAccessKeyId No description.
ResetAccountId No description.
ResetAccountSpecificNamespaceRules No description.
ResetCspmResourceCollectionEnabled No description.
ResetExcludedRegions No description.
ResetExtendedResourceCollectionEnabled No description.
ResetFilterTags No description.
ResetHostTags No description.
ResetId No description.
ResetMetricsCollectionEnabled No description.
ResetResourceCollectionEnabled No description.
ResetRoleName No description.
ResetSecretAccessKey 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".


ResetAccessKeyId
func ResetAccessKeyId()
ResetAccountId
func ResetAccountId()
ResetAccountSpecificNamespaceRules
func ResetAccountSpecificNamespaceRules()
ResetCspmResourceCollectionEnabled
func ResetCspmResourceCollectionEnabled()
ResetExcludedRegions
func ResetExcludedRegions()
ResetExtendedResourceCollectionEnabled
func ResetExtendedResourceCollectionEnabled()
ResetFilterTags
func ResetFilterTags()
ResetHostTags
func ResetHostTags()
ResetId
func ResetId()
ResetMetricsCollectionEnabled
func ResetMetricsCollectionEnabled()
ResetResourceCollectionEnabled
func ResetResourceCollectionEnabled()
ResetRoleName
func ResetRoleName()
ResetSecretAccessKey
func ResetSecretAccessKey()

Static Functions

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

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

integrationaws.IntegrationAws_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/integrationaws"

integrationaws.IntegrationAws_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

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

integrationaws.IntegrationAws_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

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

integrationaws.IntegrationAws_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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


importFromIdRequired
  • Type: *string

The id of the existing IntegrationAws that should be imported.

Refer to the {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#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 IntegrationAws 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.
ExternalId *string No description.
AccessKeyIdInput *string No description.
AccountIdInput *string No description.
AccountSpecificNamespaceRulesInput *map[string]interface{} No description.
CspmResourceCollectionEnabledInput *string No description.
ExcludedRegionsInput *[]*string No description.
ExtendedResourceCollectionEnabledInput *string No description.
FilterTagsInput *[]*string No description.
HostTagsInput *[]*string No description.
IdInput *string No description.
MetricsCollectionEnabledInput *string No description.
ResourceCollectionEnabledInput *string No description.
RoleNameInput *string No description.
SecretAccessKeyInput *string No description.
AccessKeyId *string No description.
AccountId *string No description.
AccountSpecificNamespaceRules *map[string]interface{} No description.
CspmResourceCollectionEnabled *string No description.
ExcludedRegions *[]*string No description.
ExtendedResourceCollectionEnabled *string No description.
FilterTags *[]*string No description.
HostTags *[]*string No description.
Id *string No description.
MetricsCollectionEnabled *string No description.
ResourceCollectionEnabled *string No description.
RoleName *string No description.
SecretAccessKey *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{}

ExternalIdRequired
func ExternalId() *string
  • Type: *string

AccessKeyIdInputOptional
func AccessKeyIdInput() *string
  • Type: *string

AccountIdInputOptional
func AccountIdInput() *string
  • Type: *string

AccountSpecificNamespaceRulesInputOptional
func AccountSpecificNamespaceRulesInput() *map[string]interface{}
  • Type: *map[string]interface{}

CspmResourceCollectionEnabledInputOptional
func CspmResourceCollectionEnabledInput() *string
  • Type: *string

ExcludedRegionsInputOptional
func ExcludedRegionsInput() *[]*string
  • Type: *[]*string

ExtendedResourceCollectionEnabledInputOptional
func ExtendedResourceCollectionEnabledInput() *string
  • Type: *string

FilterTagsInputOptional
func FilterTagsInput() *[]*string
  • Type: *[]*string

HostTagsInputOptional
func HostTagsInput() *[]*string
  • Type: *[]*string

IdInputOptional
func IdInput() *string
  • Type: *string

MetricsCollectionEnabledInputOptional
func MetricsCollectionEnabledInput() *string
  • Type: *string

ResourceCollectionEnabledInputOptional
func ResourceCollectionEnabledInput() *string
  • Type: *string

RoleNameInputOptional
func RoleNameInput() *string
  • Type: *string

SecretAccessKeyInputOptional
func SecretAccessKeyInput() *string
  • Type: *string

AccessKeyIdRequired
func AccessKeyId() *string
  • Type: *string

AccountIdRequired
func AccountId() *string
  • Type: *string

AccountSpecificNamespaceRulesRequired
func AccountSpecificNamespaceRules() *map[string]interface{}
  • Type: *map[string]interface{}

CspmResourceCollectionEnabledRequired
func CspmResourceCollectionEnabled() *string
  • Type: *string

ExcludedRegionsRequired
func ExcludedRegions() *[]*string
  • Type: *[]*string

ExtendedResourceCollectionEnabledRequired
func ExtendedResourceCollectionEnabled() *string
  • Type: *string

FilterTagsRequired
func FilterTags() *[]*string
  • Type: *[]*string

HostTagsRequired
func HostTags() *[]*string
  • Type: *[]*string

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

MetricsCollectionEnabledRequired
func MetricsCollectionEnabled() *string
  • Type: *string

ResourceCollectionEnabledRequired
func ResourceCollectionEnabled() *string
  • Type: *string

RoleNameRequired
func RoleName() *string
  • Type: *string

SecretAccessKeyRequired
func SecretAccessKey() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

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

Structs

IntegrationAwsConfig

Initializer

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

&integrationaws.IntegrationAwsConfig {
	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{},
	AccessKeyId: *string,
	AccountId: *string,
	AccountSpecificNamespaceRules: *map[string]interface{},
	CspmResourceCollectionEnabled: *string,
	ExcludedRegions: *[]*string,
	ExtendedResourceCollectionEnabled: *string,
	FilterTags: *[]*string,
	HostTags: *[]*string,
	Id: *string,
	MetricsCollectionEnabled: *string,
	ResourceCollectionEnabled: *string,
	RoleName: *string,
	SecretAccessKey: *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.
AccessKeyId *string Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.
AccountId *string Your AWS Account ID without dashes.
AccountSpecificNamespaceRules *map[string]interface{} Enables or disables metric collection for specific AWS namespaces for this AWS account only.
CspmResourceCollectionEnabled *string Whether Datadog collects cloud security posture management resources from your AWS account.
ExcludedRegions *[]*string An array of AWS regions to exclude from metrics collection.
ExtendedResourceCollectionEnabled *string Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection_enabled.
FilterTags *[]*string Array of EC2 tags (in the form key:value) defines a filter that Datadog uses when collecting metrics from EC2.
HostTags *[]*string Array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#id IntegrationAws#id}.
MetricsCollectionEnabled *string Whether Datadog collects metrics for this AWS account.
ResourceCollectionEnabled *string Whether Datadog collects a standard set of resources from your AWS account. Deprecated. Deprecated in favor of extended_resource_collection_enabled.
RoleName *string Your Datadog role delegation name.
SecretAccessKey *string Your AWS secret access key. Only required if your AWS account is a GovCloud or China account.

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

AccessKeyIdOptional
AccessKeyId *string
  • Type: *string

Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#access_key_id IntegrationAws#access_key_id}


AccountIdOptional
AccountId *string
  • Type: *string

Your AWS Account ID without dashes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#account_id IntegrationAws#account_id}


AccountSpecificNamespaceRulesOptional
AccountSpecificNamespaceRules *map[string]interface{}
  • Type: *map[string]interface{}

Enables or disables metric collection for specific AWS namespaces for this AWS account only.

A list of namespaces can be found at the available namespace rules API endpoint.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#account_specific_namespace_rules IntegrationAws#account_specific_namespace_rules}


CspmResourceCollectionEnabledOptional
CspmResourceCollectionEnabled *string
  • Type: *string

Whether Datadog collects cloud security posture management resources from your AWS account.

This includes additional resources not covered under the general resource_collection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#cspm_resource_collection_enabled IntegrationAws#cspm_resource_collection_enabled}


ExcludedRegionsOptional
ExcludedRegions *[]*string
  • Type: *[]*string

An array of AWS regions to exclude from metrics collection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#excluded_regions IntegrationAws#excluded_regions}


ExtendedResourceCollectionEnabledOptional
ExtendedResourceCollectionEnabled *string
  • Type: *string

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection_enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#extended_resource_collection_enabled IntegrationAws#extended_resource_collection_enabled}


FilterTagsOptional
FilterTags *[]*string
  • Type: *[]*string

Array of EC2 tags (in the form key:value) defines a filter that Datadog uses when collecting metrics from EC2.

Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding ! before the tag. e.x. env:production,instance-type:c1.*,!region:us-east-1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#filter_tags IntegrationAws#filter_tags}


HostTagsOptional
HostTags *[]*string
  • Type: *[]*string

Array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#host_tags IntegrationAws#host_tags}


IdOptional
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#id IntegrationAws#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.


MetricsCollectionEnabledOptional
MetricsCollectionEnabled *string
  • Type: *string

Whether Datadog collects metrics for this AWS account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#metrics_collection_enabled IntegrationAws#metrics_collection_enabled}


ResourceCollectionEnabledOptional
ResourceCollectionEnabled *string
  • Type: *string

Whether Datadog collects a standard set of resources from your AWS account. Deprecated. Deprecated in favor of extended_resource_collection_enabled.

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


RoleNameOptional
RoleName *string
  • Type: *string

Your Datadog role delegation name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#role_name IntegrationAws#role_name}


SecretAccessKeyOptional
SecretAccessKey *string
  • Type: *string

Your AWS secret access key. Only required if your AWS account is a GovCloud or China account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/integration_aws#secret_access_key IntegrationAws#secret_access_key}