Skip to content

Latest commit

 

History

History
1412 lines (875 loc) · 61.8 KB

pushBasedLogExport.go.md

File metadata and controls

1412 lines (875 loc) · 61.8 KB

pushBasedLogExport Submodule

Constructs

PushBasedLogExport

Represents a {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export mongodbatlas_push_based_log_export}.

Initializers

import "github.com/cdktf/cdktf-provider-mongodbatlas-go/mongodbatlas/v7/pushbasedlogexport"

pushbasedlogexport.NewPushBasedLogExport(scope Construct, id *string, config PushBasedLogExportConfig) PushBasedLogExport
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 PushBasedLogExportConfig 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".
PutTimeouts No description.
ResetPrefixPath No description.
ResetTimeouts 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".


PutTimeouts
func PutTimeouts(value PushBasedLogExportTimeouts)
valueRequired

ResetPrefixPath
func ResetPrefixPath()
ResetTimeouts
func ResetTimeouts()

Static Functions

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

IsConstruct
import "github.com/cdktf/cdktf-provider-mongodbatlas-go/mongodbatlas/v7/pushbasedlogexport"

pushbasedlogexport.PushBasedLogExport_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-mongodbatlas-go/mongodbatlas/v7/pushbasedlogexport"

pushbasedlogexport.PushBasedLogExport_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformResource
import "github.com/cdktf/cdktf-provider-mongodbatlas-go/mongodbatlas/v7/pushbasedlogexport"

pushbasedlogexport.PushBasedLogExport_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-mongodbatlas-go/mongodbatlas/v7/pushbasedlogexport"

pushbasedlogexport.PushBasedLogExport_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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


importFromIdRequired
  • Type: *string

The id of the existing PushBasedLogExport that should be imported.

Refer to the {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#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 PushBasedLogExport 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.
CreateDate *string No description.
State *string No description.
Timeouts PushBasedLogExportTimeoutsOutputReference No description.
BucketNameInput *string No description.
IamRoleIdInput *string No description.
PrefixPathInput *string No description.
ProjectIdInput *string No description.
TimeoutsInput interface{} No description.
BucketName *string No description.
IamRoleId *string No description.
PrefixPath *string No description.
ProjectId *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{}

CreateDateRequired
func CreateDate() *string
  • Type: *string

StateRequired
func State() *string
  • Type: *string

TimeoutsRequired
func Timeouts() PushBasedLogExportTimeoutsOutputReference

BucketNameInputOptional
func BucketNameInput() *string
  • Type: *string

IamRoleIdInputOptional
func IamRoleIdInput() *string
  • Type: *string

PrefixPathInputOptional
func PrefixPathInput() *string
  • Type: *string

ProjectIdInputOptional
func ProjectIdInput() *string
  • Type: *string

TimeoutsInputOptional
func TimeoutsInput() interface{}
  • Type: interface{}

BucketNameRequired
func BucketName() *string
  • Type: *string

IamRoleIdRequired
func IamRoleId() *string
  • Type: *string

PrefixPathRequired
func PrefixPath() *string
  • Type: *string

ProjectIdRequired
func ProjectId() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

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

Structs

PushBasedLogExportConfig

Initializer

import "github.com/cdktf/cdktf-provider-mongodbatlas-go/mongodbatlas/v7/pushbasedlogexport"

&pushbasedlogexport.PushBasedLogExportConfig {
	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{},
	BucketName: *string,
	IamRoleId: *string,
	ProjectId: *string,
	PrefixPath: *string,
	Timeouts: github.com/cdktf/cdktf-provider-mongodbatlas-go/mongodbatlas/v7.pushBasedLogExport.PushBasedLogExportTimeouts,
}

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.
BucketName *string The name of the bucket to which the agent sends the logs to.
IamRoleId *string ID of the AWS IAM role that is used to write to the S3 bucket.
ProjectId *string Unique 24-hexadecimal digit string that identifies your project.
PrefixPath *string S3 directory in which vector writes in order to store the logs. An empty string denotes the root directory.
Timeouts PushBasedLogExportTimeouts Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#timeouts PushBasedLogExport#timeouts}.

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

BucketNameRequired
BucketName *string
  • Type: *string

The name of the bucket to which the agent sends the logs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#bucket_name PushBasedLogExport#bucket_name}


IamRoleIdRequired
IamRoleId *string
  • Type: *string

ID of the AWS IAM role that is used to write to the S3 bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#iam_role_id PushBasedLogExport#iam_role_id}


ProjectIdRequired
ProjectId *string
  • Type: *string

Unique 24-hexadecimal digit string that identifies your project.

Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#project_id PushBasedLogExport#project_id}


PrefixPathOptional
PrefixPath *string
  • Type: *string

S3 directory in which vector writes in order to store the logs. An empty string denotes the root directory.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#prefix_path PushBasedLogExport#prefix_path}


TimeoutsOptional
Timeouts PushBasedLogExportTimeouts

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#timeouts PushBasedLogExport#timeouts}.


PushBasedLogExportTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-mongodbatlas-go/mongodbatlas/v7/pushbasedlogexport"

&pushbasedlogexport.PushBasedLogExportTimeouts {
	Create: *string,
	Delete: *string,
	Update: *string,
}

Properties

Name Type Description
Create *string A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Delete *string A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Update *string A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

CreateOptional
Create *string
  • Type: *string

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#create PushBasedLogExport#create}


DeleteOptional
Delete *string
  • Type: *string

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#delete PushBasedLogExport#delete}


UpdateOptional
Update *string
  • Type: *string

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.24.0/docs/resources/push_based_log_export#update PushBasedLogExport#update}


Classes

PushBasedLogExportTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-mongodbatlas-go/mongodbatlas/v7/pushbasedlogexport"

pushbasedlogexport.NewPushBasedLogExportTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) PushBasedLogExportTimeoutsOutputReference
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.

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.


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

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.

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

CreateInputOptional
func CreateInput() *string
  • Type: *string

DeleteInputOptional
func DeleteInput() *string
  • Type: *string

UpdateInputOptional
func UpdateInput() *string
  • Type: *string

CreateRequired
func Create() *string
  • Type: *string

DeleteRequired
func Delete() *string
  • Type: *string

UpdateRequired
func Update() *string
  • Type: *string

InternalValueOptional
func InternalValue() interface{}
  • Type: interface{}