Skip to content

Latest commit

 

History

History
1011 lines (630 loc) · 41.4 KB

provider.java.md

File metadata and controls

1011 lines (630 loc) · 41.4 KB
Raw

provider Submodule

Constructs

IonoscloudProvider

Represents a {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs ionoscloud}.

Initializers 

import com.hashicorp.cdktf.providers.ionoscloud.provider.IonoscloudProvider;

IonoscloudProvider.Builder.create(Construct scope, java.lang.String id)
//  .alias(java.lang.String)
//  .contractNumber(java.lang.String)
//  .endpoint(java.lang.String)
//  .insecure(java.lang.Boolean)
//  .insecure(IResolvable)
//  .password(java.lang.String)
//  .retries(java.lang.Number)
//  .s3AccessKey(java.lang.String)
//  .s3Region(java.lang.String)
//  .s3SecretKey(java.lang.String)
//  .token(java.lang.String)
//  .username(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
alias java.lang.String Alias name.
contractNumber java.lang.String To be set only for reseller accounts. Allows to run terraform on a contract number under a reseller account.
endpoint java.lang.String IonosCloud REST API URL.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This field is to be set only for testing purposes.
password java.lang.String IonosCloud password for API operations. If token is provided, token is preferred.
retries java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#retries IonoscloudProvider#retries}.
s3AccessKey java.lang.String Access key for IONOS Object Storage operations.
s3Region java.lang.String Region for IONOS Object Storage operations.
s3SecretKey java.lang.String Secret key for IONOS Object Storage operations.
token java.lang.String IonosCloud bearer token for API operations.
username java.lang.String IonosCloud username for API operations. If token is provided, token is preferred.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#alias IonoscloudProvider#alias}

contractNumberOptional
  • Type: java.lang.String

To be set only for reseller accounts. Allows to run terraform on a contract number under a reseller account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#contract_number IonoscloudProvider#contract_number}

endpointOptional
  • Type: java.lang.String

IonosCloud REST API URL.

Usually not necessary to be set, SDKs know internally how to route requests to the API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#endpoint IonoscloudProvider#endpoint}

insecureOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

This field is to be set only for testing purposes.

It is not recommended to set this field in production environments.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#insecure IonoscloudProvider#insecure}

passwordOptional
  • Type: java.lang.String

IonosCloud password for API operations. If token is provided, token is preferred.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#password IonoscloudProvider#password}

retriesOptional
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#retries IonoscloudProvider#retries}.

s3AccessKeyOptional
  • Type: java.lang.String

Access key for IONOS Object Storage operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#s3_access_key IonoscloudProvider#s3_access_key}

s3RegionOptional
  • Type: java.lang.String

Region for IONOS Object Storage operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#s3_region IonoscloudProvider#s3_region}

s3SecretKeyOptional
  • Type: java.lang.String

Secret key for IONOS Object Storage operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#s3_secret_key IonoscloudProvider#s3_secret_key}

tokenOptional
  • Type: java.lang.String

IonosCloud bearer token for API operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#token IonoscloudProvider#token}

usernameOptional
  • Type: java.lang.String

IonosCloud username for API operations. If token is provided, token is preferred.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#username IonoscloudProvider#username}

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.
resetContractNumber No description.
resetEndpoint No description.
resetInsecure No description.
resetPassword No description.
resetRetries No description.
resetS3AccessKey No description.
resetS3Region No description.
resetS3SecretKey No description.
resetToken No description.
resetUsername No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

resetAlias 
public void resetAlias()
resetContractNumber 
public void resetContractNumber()
resetEndpoint 
public void resetEndpoint()
resetInsecure 
public void resetInsecure()
resetPassword 
public void resetPassword()
resetRetries 
public void resetRetries()
resetS3AccessKey 
public void resetS3AccessKey()
resetS3Region 
public void resetS3Region()
resetS3SecretKey 
public void resetS3SecretKey()
resetToken 
public void resetToken()
resetUsername 
public void resetUsername()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformProvider No description.
generateConfigForImport Generates CDKTF code for importing a IonoscloudProvider resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.ionoscloud.provider.IonoscloudProvider;

IonoscloudProvider.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.ionoscloud.provider.IonoscloudProvider;

IonoscloudProvider.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformProvider 
import com.hashicorp.cdktf.providers.ionoscloud.provider.IonoscloudProvider;

IonoscloudProvider.isTerraformProvider(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.ionoscloud.provider.IonoscloudProvider;

IonoscloudProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),IonoscloudProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing IonoscloudProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
metaAttributes java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
terraformProviderSource java.lang.String No description.
alias java.lang.String No description.
aliasInput java.lang.String No description.
contractNumberInput java.lang.String No description.
endpointInput java.lang.String No description.
insecureInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
passwordInput java.lang.String No description.
retriesInput java.lang.Number No description.
s3AccessKeyInput java.lang.String No description.
s3RegionInput java.lang.String No description.
s3SecretKeyInput java.lang.String No description.
tokenInput java.lang.String No description.
usernameInput java.lang.String No description.
contractNumber java.lang.String No description.
endpoint java.lang.String No description.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
password java.lang.String No description.
retries java.lang.Number No description.
s3AccessKey java.lang.String No description.
s3Region java.lang.String No description.
s3SecretKey java.lang.String No description.
token java.lang.String No description.
username java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
metaAttributesRequired 
public java.util.Map<java.lang.String, java.lang.Object> getMetaAttributes();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
terraformProviderSourceOptional 
public java.lang.String getTerraformProviderSource();
  • Type: java.lang.String
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String
aliasInputOptional 
public java.lang.String getAliasInput();
  • Type: java.lang.String
contractNumberInputOptional 
public java.lang.String getContractNumberInput();
  • Type: java.lang.String
endpointInputOptional 
public java.lang.String getEndpointInput();
  • Type: java.lang.String
insecureInputOptional 
public java.lang.Object getInsecureInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
passwordInputOptional 
public java.lang.String getPasswordInput();
  • Type: java.lang.String
retriesInputOptional 
public java.lang.Number getRetriesInput();
  • Type: java.lang.Number
s3AccessKeyInputOptional 
public java.lang.String getS3AccessKeyInput();
  • Type: java.lang.String
s3RegionInputOptional 
public java.lang.String getS3RegionInput();
  • Type: java.lang.String
s3SecretKeyInputOptional 
public java.lang.String getS3SecretKeyInput();
  • Type: java.lang.String
tokenInputOptional 
public java.lang.String getTokenInput();
  • Type: java.lang.String
usernameInputOptional 
public java.lang.String getUsernameInput();
  • Type: java.lang.String
contractNumberOptional 
public java.lang.String getContractNumber();
  • Type: java.lang.String
endpointOptional 
public java.lang.String getEndpoint();
  • Type: java.lang.String
insecureOptional 
public java.lang.Object getInsecure();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String
retriesOptional 
public java.lang.Number getRetries();
  • Type: java.lang.Number
s3AccessKeyOptional 
public java.lang.String getS3AccessKey();
  • Type: java.lang.String
s3RegionOptional 
public java.lang.String getS3Region();
  • Type: java.lang.String
s3SecretKeyOptional 
public java.lang.String getS3SecretKey();
  • Type: java.lang.String
tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String
usernameOptional 
public java.lang.String getUsername();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

IonoscloudProviderConfig

Initializer 

import com.hashicorp.cdktf.providers.ionoscloud.provider.IonoscloudProviderConfig;

IonoscloudProviderConfig.builder()
//  .alias(java.lang.String)
//  .contractNumber(java.lang.String)
//  .endpoint(java.lang.String)
//  .insecure(java.lang.Boolean)
//  .insecure(IResolvable)
//  .password(java.lang.String)
//  .retries(java.lang.Number)
//  .s3AccessKey(java.lang.String)
//  .s3Region(java.lang.String)
//  .s3SecretKey(java.lang.String)
//  .token(java.lang.String)
//  .username(java.lang.String)
    .build();

Properties

Name Type Description
alias java.lang.String Alias name.
contractNumber java.lang.String To be set only for reseller accounts. Allows to run terraform on a contract number under a reseller account.
endpoint java.lang.String IonosCloud REST API URL.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This field is to be set only for testing purposes.
password java.lang.String IonosCloud password for API operations. If token is provided, token is preferred.
retries java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#retries IonoscloudProvider#retries}.
s3AccessKey java.lang.String Access key for IONOS Object Storage operations.
s3Region java.lang.String Region for IONOS Object Storage operations.
s3SecretKey java.lang.String Secret key for IONOS Object Storage operations.
token java.lang.String IonosCloud bearer token for API operations.
username java.lang.String IonosCloud username for API operations. If token is provided, token is preferred.
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#alias IonoscloudProvider#alias}

contractNumberOptional 
public java.lang.String getContractNumber();
  • Type: java.lang.String

To be set only for reseller accounts. Allows to run terraform on a contract number under a reseller account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#contract_number IonoscloudProvider#contract_number}

endpointOptional 
public java.lang.String getEndpoint();
  • Type: java.lang.String

IonosCloud REST API URL.

Usually not necessary to be set, SDKs know internally how to route requests to the API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#endpoint IonoscloudProvider#endpoint}

insecureOptional 
public java.lang.Object getInsecure();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

This field is to be set only for testing purposes.

It is not recommended to set this field in production environments.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#insecure IonoscloudProvider#insecure}

passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String

IonosCloud password for API operations. If token is provided, token is preferred.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#password IonoscloudProvider#password}

retriesOptional 
public java.lang.Number getRetries();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#retries IonoscloudProvider#retries}.

s3AccessKeyOptional 
public java.lang.String getS3AccessKey();
  • Type: java.lang.String

Access key for IONOS Object Storage operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#s3_access_key IonoscloudProvider#s3_access_key}

s3RegionOptional 
public java.lang.String getS3Region();
  • Type: java.lang.String

Region for IONOS Object Storage operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#s3_region IonoscloudProvider#s3_region}

s3SecretKeyOptional 
public java.lang.String getS3SecretKey();
  • Type: java.lang.String

Secret key for IONOS Object Storage operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#s3_secret_key IonoscloudProvider#s3_secret_key}

tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String

IonosCloud bearer token for API operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#token IonoscloudProvider#token}

usernameOptional 
public java.lang.String getUsername();
  • Type: java.lang.String

IonosCloud username for API operations. If token is provided, token is preferred.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs#username IonoscloudProvider#username}