Skip to content

Latest commit

 

History

History
429 lines (262 loc) · 15.5 KB

provider.go.md

File metadata and controls

429 lines (262 loc) · 15.5 KB
Raw

provider Submodule

Constructs

RandomProvider

Represents a {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs random}.

Initializers 

import "github.com/cdktf/cdktf-provider-random-go/random/v11/provider"

provider.NewRandomProvider(scope Construct, id *string, config RandomProviderConfig) RandomProvider
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 RandomProviderConfig 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.
ResetAlias 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.

ResetAlias 
func ResetAlias()

Static Functions

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

provider.RandomProvider_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-random-go/random/v11/provider"

provider.RandomProvider_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformProvider 
import "github.com/cdktf/cdktf-provider-random-go/random/v11/provider"

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

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

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

importFromIdRequired
  • Type: *string

The id of the existing RandomProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs#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 RandomProvider 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.
MetaAttributes *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
TerraformProviderSource *string No description.
Alias *string No description.
AliasInput *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
MetaAttributesRequired 
func MetaAttributes() *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
TerraformProviderSourceOptional 
func TerraformProviderSource() *string
  • Type: *string
AliasOptional 
func Alias() *string
  • Type: *string
AliasInputOptional 
func AliasInput() *string
  • Type: *string

Constants

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

Structs

RandomProviderConfig

Initializer 

import "github.com/cdktf/cdktf-provider-random-go/random/v11/provider"

&provider.RandomProviderConfig {
	Alias: *string,
}

Properties

Name Type Description
Alias *string Alias name.
AliasOptional 
Alias *string
  • Type: *string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/random/3.6.1/docs#alias RandomProvider#alias}