`provider` Submodule

Constructs

SpotinstProvider

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

Initializers

from cdktf_cdktf_provider_spotinst import provider

provider.SpotinstProvider(
  scope: Construct,
  id: str,
  account: str = None,
  alias: str = None,
  enabled: typing.Union[bool, IResolvable] = None,
  feature_flags: str = None,
  token: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`account`	`str`	Spotinst Account ID.
`alias`	`str`	Alias name.
`enabled`	`typing.Union[bool, cdktf.IResolvable]`	Enable or disable the Spotinst provider.
`feature_flags`	`str`	Spotinst SDK Feature Flags.
`token`	`str`	Spotinst Personal API Access Token.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`account`^Optional

Type: str

Spotinst Account ID.

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

`alias`^Optional

Type: str

Alias name.

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

`enabled`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

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}

`feature_flags`^Optional

Type: str

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}

`token`^Optional

Type: str

Spotinst Personal API Access Token.

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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`reset_account`	No description.
`reset_alias`	No description.
`reset_enabled`	No description.
`reset_feature_flags`	No description.
`reset_token`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`reset_account`

def reset_account() -> None

`reset_alias`

def reset_alias() -> None

`reset_enabled`

def reset_enabled() -> None

`reset_feature_flags`

def reset_feature_flags() -> None

`reset_token`

def reset_token() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_provider`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a SpotinstProvider resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_spotinst import provider

provider.SpotinstProvider.is_construct(
  x: typing.Any
)

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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_spotinst import provider

provider.SpotinstProvider.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_provider`

from cdktf_cdktf_provider_spotinst import provider

provider.SpotinstProvider.is_terraform_provider(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_spotinst import provider

provider.SpotinstProvider.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a SpotinstProvider resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

The construct id used in the generated config for the SpotinstProvider to import.

`import_from_id`^Required

Type: str

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

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the SpotinstProvider to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`meta_attributes`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`terraform_provider_source`	`str`	No description.
`alias`	`str`	No description.
`account_input`	`str`	No description.
`alias_input`	`str`	No description.
`enabled_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`feature_flags_input`	`str`	No description.
`token_input`	`str`	No description.
`account`	`str`	No description.
`enabled`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`feature_flags`	`str`	No description.
`token`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`meta_attributes`^Required

meta_attributes: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`terraform_provider_source`^Optional

terraform_provider_source: str

Type: str

`alias`^Optional

alias: str

Type: str

`account_input`^Optional

account_input: str

Type: str

`alias_input`^Optional

alias_input: str

Type: str

`enabled_input`^Optional

enabled_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`feature_flags_input`^Optional

feature_flags_input: str

Type: str

`token_input`^Optional

token_input: str

Type: str

`account`^Optional

account: str

Type: str

`enabled`^Optional

enabled: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`feature_flags`^Optional

feature_flags: str

Type: str

`token`^Optional

token: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

SpotinstProviderConfig

Initializer

from cdktf_cdktf_provider_spotinst import provider

provider.SpotinstProviderConfig(
  account: str = None,
  alias: str = None,
  enabled: typing.Union[bool, IResolvable] = None,
  feature_flags: str = None,
  token: str = None
)

Properties

Name	Type	Description
`account`	`str`	Spotinst Account ID.
`alias`	`str`	Alias name.
`enabled`	`typing.Union[bool, cdktf.IResolvable]`	Enable or disable the Spotinst provider.
`feature_flags`	`str`	Spotinst SDK Feature Flags.
`token`	`str`	Spotinst Personal API Access Token.

`account`^Optional

account: str

Type: str

Spotinst Account ID.

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

`alias`^Optional

alias: str

Type: str

Alias name.

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

`enabled`^Optional

enabled: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

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}

`feature_flags`^Optional

feature_flags: str

Type: str

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}

`token`^Optional

token: str

Type: str

Spotinst Personal API Access Token.

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

Files

provider.python.md

Latest commit

History

provider.python.md

File metadata and controls

provider Submodule

Constructs

SpotinstProvider

Initializers

scopeRequired

idRequired

accountOptional

aliasOptional

enabledOptional

feature_flagsOptional

tokenOptional

Methods

to_string

add_override

pathRequired

valueRequired

override_logical_id

new_logical_idRequired

reset_override_logical_id

to_hcl_terraform

to_metadata

to_terraform

reset_account

reset_alias

reset_enabled

reset_feature_flags

reset_token

Static Functions

is_construct

xRequired

is_terraform_element

xRequired

is_terraform_provider

xRequired

generate_config_for_import

scopeRequired

import_to_idRequired

import_from_idRequired

providerOptional

Properties

nodeRequired

cdktf_stackRequired

fqnRequired

friendly_unique_idRequired

meta_attributesRequired

terraform_resource_typeRequired

terraform_generator_metadataOptional

terraform_provider_sourceOptional

aliasOptional

account_inputOptional

alias_inputOptional

enabled_inputOptional

feature_flags_inputOptional

token_inputOptional

accountOptional

enabledOptional

feature_flagsOptional

tokenOptional

Constants

tfResourceTypeRequired

Structs

SpotinstProviderConfig

Initializer

Properties

accountOptional

aliasOptional

enabledOptional

feature_flagsOptional

tokenOptional

`provider` Submodule

`scope`^Required

`id`^Required

`account`^Optional

`alias`^Optional

`enabled`^Optional

`feature_flags`^Optional

`token`^Optional

`to_string`

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`reset_account`

`reset_alias`

`reset_enabled`

`reset_feature_flags`

`reset_token`

`is_construct`

`x`^Required

`is_terraform_element`

`x`^Required

`is_terraform_provider`

`x`^Required

`generate_config_for_import`

`scope`^Required

`import_to_id`^Required

`import_from_id`^Required

`provider`^Optional

`node`^Required

`cdktf_stack`^Required

`fqn`^Required

`friendly_unique_id`^Required

`meta_attributes`^Required

`terraform_resource_type`^Required

`terraform_generator_metadata`^Optional

`terraform_provider_source`^Optional

`alias`^Optional

`account_input`^Optional

`alias_input`^Optional

`enabled_input`^Optional

`feature_flags_input`^Optional

`token_input`^Optional

`account`^Optional

`enabled`^Optional

`feature_flags`^Optional

`token`^Optional

`tfResourceType`^Required

`account`^Optional

`alias`^Optional

`enabled`^Optional

`feature_flags`^Optional

`token`^Optional