Skip to content

Latest commit

 

History

History
609 lines (378 loc) · 22 KB

provider.go.md

File metadata and controls

609 lines (378 loc) · 22 KB

provider Submodule

Constructs

SpotinstProvider

Represents a {@link https://registry.terraform.io/providers/spotinst/spotinst/1.199.0/docs spotinst}.

Initializers

import "github.com/cdktf/cdktf-provider-spotinst-go/spotinst/v13/provider"

provider.NewSpotinstProvider(scope Construct, id *string, config SpotinstProviderConfig) SpotinstProvider
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 SpotinstProviderConfig 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.
ResetAccount No description.
ResetAlias No description.
ResetEnabled No description.
ResetFeatureFlags No description.
ResetToken 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.

ResetAccount
func ResetAccount()
ResetAlias
func ResetAlias()
ResetEnabled
func ResetEnabled()
ResetFeatureFlags
func ResetFeatureFlags()
ResetToken
func ResetToken()

Static Functions

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

IsConstruct
import "github.com/cdktf/cdktf-provider-spotinst-go/spotinst/v13/provider"

provider.SpotinstProvider_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-spotinst-go/spotinst/v13/provider"

provider.SpotinstProvider_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformProvider
import "github.com/cdktf/cdktf-provider-spotinst-go/spotinst/v13/provider"

provider.SpotinstProvider_IsTerraformProvider(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-spotinst-go/spotinst/v13/provider"

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

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


importFromIdRequired
  • Type: *string

The id of the existing SpotinstProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/spotinst/spotinst/1.199.0/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 SpotinstProvider 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.
AccountInput *string No description.
AliasInput *string No description.
EnabledInput interface{} No description.
FeatureFlagsInput *string No description.
TokenInput *string No description.
Account *string No description.
Enabled interface{} No description.
FeatureFlags *string No description.
Token *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

AccountInputOptional
func AccountInput() *string
  • Type: *string

AliasInputOptional
func AliasInput() *string
  • Type: *string

EnabledInputOptional
func EnabledInput() interface{}
  • Type: interface{}

FeatureFlagsInputOptional
func FeatureFlagsInput() *string
  • Type: *string

TokenInputOptional
func TokenInput() *string
  • Type: *string

AccountOptional
func Account() *string
  • Type: *string

EnabledOptional
func Enabled() interface{}
  • Type: interface{}

FeatureFlagsOptional
func FeatureFlags() *string
  • Type: *string

TokenOptional
func Token() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

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

Structs

SpotinstProviderConfig

Initializer

import "github.com/cdktf/cdktf-provider-spotinst-go/spotinst/v13/provider"

&provider.SpotinstProviderConfig {
	Account: *string,
	Alias: *string,
	Enabled: interface{},
	FeatureFlags: *string,
	Token: *string,
}

Properties

Name Type Description
Account *string Spotinst Account ID.
Alias *string Alias name.
Enabled interface{} Enable or disable the Spotinst provider.
FeatureFlags *string Spotinst SDK Feature Flags.
Token *string Spotinst Personal API Access Token.

AccountOptional
Account *string
  • Type: *string

Spotinst Account ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/spotinst/spotinst/1.199.0/docs#account SpotinstProvider#account}


AliasOptional
Alias *string
  • Type: *string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/spotinst/spotinst/1.199.0/docs#alias SpotinstProvider#alias}


EnabledOptional
Enabled interface{}
  • Type: interface{}

Enable or disable the Spotinst provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/spotinst/spotinst/1.199.0/docs#enabled SpotinstProvider#enabled}


FeatureFlagsOptional
FeatureFlags *string
  • Type: *string

Spotinst SDK Feature Flags.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/spotinst/spotinst/1.199.0/docs#feature_flags SpotinstProvider#feature_flags}


TokenOptional
Token *string
  • Type: *string

Spotinst Personal API Access Token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/spotinst/spotinst/1.199.0/docs#token SpotinstProvider#token}