Skip to content

Latest commit

 

History

History
1404 lines (861 loc) · 54.3 KB

ipAllowlist.go.md

File metadata and controls

1404 lines (861 loc) · 54.3 KB
Raw

ipAllowlist Submodule

Constructs

IpAllowlist

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

Initializers 

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

ipallowlist.NewIpAllowlist(scope Construct, id *string, config IpAllowlistConfig) IpAllowlist
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 IpAllowlistConfig 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".
PutEntry No description.
ResetEntry 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".

PutEntry 
func PutEntry(value interface{})
valueRequired
  • Type: interface{}
ResetEntry 
func ResetEntry()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a IpAllowlist resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/ipallowlist"

ipallowlist.IpAllowlist_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/ipallowlist"

ipallowlist.IpAllowlist_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/ipallowlist"

ipallowlist.IpAllowlist_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/ipallowlist"

ipallowlist.IpAllowlist_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

importFromIdRequired
  • Type: *string

The id of the existing IpAllowlist that should be imported.

Refer to the {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/ip_allowlist#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 IpAllowlist 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.
Entry IpAllowlistEntryList No description.
Id *string No description.
EnabledInput interface{} No description.
EntryInput interface{} No description.
Enabled interface{} 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{}
EntryRequired 
func Entry() IpAllowlistEntryList
IdRequired 
func Id() *string
  • Type: *string
EnabledInputOptional 
func EnabledInput() interface{}
  • Type: interface{}
EntryInputOptional 
func EntryInput() interface{}
  • Type: interface{}
EnabledRequired 
func Enabled() interface{}
  • Type: interface{}

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

IpAllowlistConfig

Initializer 

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

&ipallowlist.IpAllowlistConfig {
	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{},
	Enabled: interface{},
	Entry: 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.
Enabled interface{} Whether the IP Allowlist is enabled.
Entry interface{} entry block.
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{}
EnabledRequired 
Enabled interface{}
  • Type: interface{}

Whether the IP Allowlist is enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/ip_allowlist#enabled IpAllowlist#enabled}

EntryOptional 
Entry interface{}
  • Type: interface{}

entry block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/ip_allowlist#entry IpAllowlist#entry}

IpAllowlistEntry

Initializer 

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

&ipallowlist.IpAllowlistEntry {
	CidrBlock: *string,
	Note: *string,
}

Properties

Name Type Description
CidrBlock *string IP address or range of addresses.
Note *string Note accompanying IP address.
CidrBlockRequired 
CidrBlock *string
  • Type: *string

IP address or range of addresses.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/ip_allowlist#cidr_block IpAllowlist#cidr_block}

NoteOptional 
Note *string
  • Type: *string

Note accompanying IP address.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/ip_allowlist#note IpAllowlist#note}

Classes

IpAllowlistEntryList

Initializers 

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

ipallowlist.NewIpAllowlistEntryList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) IpAllowlistEntryList
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).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

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

mapKeyAttributeNameRequired
  • Type: *string
ComputeFqn 
func ComputeFqn() *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • 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) IpAllowlistEntryOutputReference
indexRequired
  • 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.
CreationStackRequired 
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.

FqnRequired 
func Fqn() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}

IpAllowlistEntryOutputReference

Initializers 

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

ipallowlist.NewIpAllowlistEntryOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) IpAllowlistEntryOutputReference
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).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: *f64

the index of this item in the list.

complexObjectIsFromSetRequired
  • 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.
ResetNote No description.
ComputeFqn 
func ComputeFqn() *string
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
InterpolationForAttribute 
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

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

ResetNote 
func ResetNote()

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.
CidrBlockInput *string No description.
NoteInput *string No description.
CidrBlock *string No description.
Note *string No description.
InternalValue interface{} No description.
CreationStackRequired 
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.

FqnRequired 
func Fqn() *string
  • Type: *string
CidrBlockInputOptional 
func CidrBlockInput() *string
  • Type: *string
NoteInputOptional 
func NoteInput() *string
  • Type: *string
CidrBlockRequired 
func CidrBlock() *string
  • Type: *string
NoteRequired 
func Note() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}