Skip to content

Latest commit

 

History

History
2029 lines (1276 loc) · 90.4 KB

provider.java.md

File metadata and controls

2029 lines (1276 loc) · 90.4 KB
Raw

provider Submodule

Constructs

OpentelekomcloudProvider

Represents a {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs opentelekomcloud}.

Initializers 

import com.hashicorp.cdktf.providers.opentelekomcloud.provider.OpentelekomcloudProvider;

OpentelekomcloudProvider.Builder.create(Construct scope, java.lang.String id)
//  .accessKey(java.lang.String)
//  .agencyDomainName(java.lang.String)
//  .agencyName(java.lang.String)
//  .alias(java.lang.String)
//  .allowReauth(java.lang.Boolean)
//  .allowReauth(IResolvable)
//  .authUrl(java.lang.String)
//  .backoffRetryTimeout(java.lang.Number)
//  .cacertFile(java.lang.String)
//  .cert(java.lang.String)
//  .cloud(java.lang.String)
//  .delegatedProject(java.lang.String)
//  .domainId(java.lang.String)
//  .domainName(java.lang.String)
//  .endpointType(java.lang.String)
//  .insecure(java.lang.Boolean)
//  .insecure(IResolvable)
//  .key(java.lang.String)
//  .maxBackoffRetries(java.lang.Number)
//  .maxRetries(java.lang.Number)
//  .passcode(java.lang.String)
//  .password(java.lang.String)
//  .region(java.lang.String)
//  .secretKey(java.lang.String)
//  .securityToken(java.lang.String)
//  .swauth(java.lang.Boolean)
//  .swauth(IResolvable)
//  .tenantId(java.lang.String)
//  .tenantName(java.lang.String)
//  .token(java.lang.String)
//  .userId(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.
accessKey java.lang.String The access key for API operations. You can retrieve this from the 'My Credential' section of the console.
agencyDomainName java.lang.String The name of domain who created the agency (Identity v3).
agencyName java.lang.String The name of agency.
alias java.lang.String Alias name.
allowReauth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#allow_reauth OpentelekomcloudProvider#allow_reauth}.
authUrl java.lang.String The Identity authentication URL.
backoffRetryTimeout java.lang.Number Timeout in seconds for backoff retry.
cacertFile java.lang.String A Custom CA certificate.
cert java.lang.String A client certificate to authenticate with.
cloud java.lang.String An entry in a clouds.yaml file to use.
delegatedProject java.lang.String The name of delegated project (Identity v3).
domainId java.lang.String The ID of the Domain to scope to (Identity v3).
domainName java.lang.String The name of the Domain to scope to (Identity v3).
endpointType java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#endpoint_type OpentelekomcloudProvider#endpoint_type}.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Trust self-signed certificates.
key java.lang.String A client private key to authenticate with.
maxBackoffRetries java.lang.Number How many times HTTP request should be retried when rate limit reached.
maxRetries java.lang.Number How many times HTTP connection should be retried until giving up.
passcode java.lang.String One-time MFA passcode.
password java.lang.String Password to login with.
region java.lang.String The OpenTelekomCloud region to connect to.
secretKey java.lang.String The secret key for API operations. You can retrieve this from the 'My Credential' section of the console.
securityToken java.lang.String Security token to use for OBS federated authentication.
swauth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Use Swift's authentication system instead of Keystone. Only used for interaction with Swift.
tenantId java.lang.String The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
tenantName java.lang.String The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
token java.lang.String Authentication token to use as an alternative to username/password.
userId java.lang.String User ID to login with.
userName java.lang.String Username to login with.
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

accessKeyOptional
  • Type: java.lang.String

The access key for API operations. You can retrieve this from the 'My Credential' section of the console.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#access_key OpentelekomcloudProvider#access_key}

agencyDomainNameOptional
  • Type: java.lang.String

The name of domain who created the agency (Identity v3).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#agency_domain_name OpentelekomcloudProvider#agency_domain_name}

agencyNameOptional
  • Type: java.lang.String

The name of agency.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#agency_name OpentelekomcloudProvider#agency_name}

aliasOptional
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#alias OpentelekomcloudProvider#alias}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#allow_reauth OpentelekomcloudProvider#allow_reauth}.

authUrlOptional
  • Type: java.lang.String

The Identity authentication URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#auth_url OpentelekomcloudProvider#auth_url}

backoffRetryTimeoutOptional
  • Type: java.lang.Number

Timeout in seconds for backoff retry.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#backoff_retry_timeout OpentelekomcloudProvider#backoff_retry_timeout}

cacertFileOptional
  • Type: java.lang.String

A Custom CA certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#cacert_file OpentelekomcloudProvider#cacert_file}

certOptional
  • Type: java.lang.String

A client certificate to authenticate with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#cert OpentelekomcloudProvider#cert}

cloudOptional
  • Type: java.lang.String

An entry in a clouds.yaml file to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#cloud OpentelekomcloudProvider#cloud}

delegatedProjectOptional
  • Type: java.lang.String

The name of delegated project (Identity v3).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#delegated_project OpentelekomcloudProvider#delegated_project}

domainIdOptional
  • Type: java.lang.String

The ID of the Domain to scope to (Identity v3).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#domain_id OpentelekomcloudProvider#domain_id}

domainNameOptional
  • Type: java.lang.String

The name of the Domain to scope to (Identity v3).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#domain_name OpentelekomcloudProvider#domain_name}

endpointTypeOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#endpoint_type OpentelekomcloudProvider#endpoint_type}.

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

Trust self-signed certificates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#insecure OpentelekomcloudProvider#insecure}

keyOptional
  • Type: java.lang.String

A client private key to authenticate with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#key OpentelekomcloudProvider#key}

maxBackoffRetriesOptional
  • Type: java.lang.Number

How many times HTTP request should be retried when rate limit reached.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#max_backoff_retries OpentelekomcloudProvider#max_backoff_retries}

maxRetriesOptional
  • Type: java.lang.Number

How many times HTTP connection should be retried until giving up.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#max_retries OpentelekomcloudProvider#max_retries}

passcodeOptional
  • Type: java.lang.String

One-time MFA passcode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#passcode OpentelekomcloudProvider#passcode}

passwordOptional
  • Type: java.lang.String

Password to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#password OpentelekomcloudProvider#password}

regionOptional
  • Type: java.lang.String

The OpenTelekomCloud region to connect to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#region OpentelekomcloudProvider#region}

secretKeyOptional
  • Type: java.lang.String

The secret key for API operations. You can retrieve this from the 'My Credential' section of the console.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#secret_key OpentelekomcloudProvider#secret_key}

securityTokenOptional
  • Type: java.lang.String

Security token to use for OBS federated authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#security_token OpentelekomcloudProvider#security_token}

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

Use Swift's authentication system instead of Keystone. Only used for interaction with Swift.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#swauth OpentelekomcloudProvider#swauth}

tenantIdOptional
  • Type: java.lang.String

The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#tenant_id OpentelekomcloudProvider#tenant_id}

tenantNameOptional
  • Type: java.lang.String

The name of the Tenant (Identity v2) or Project (Identity v3) to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#tenant_name OpentelekomcloudProvider#tenant_name}

tokenOptional
  • Type: java.lang.String

Authentication token to use as an alternative to username/password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#token OpentelekomcloudProvider#token}

userIdOptional
  • Type: java.lang.String

User ID to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#user_id OpentelekomcloudProvider#user_id}

userNameOptional
  • Type: java.lang.String

Username to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#user_name OpentelekomcloudProvider#user_name}

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.
resetAccessKey No description.
resetAgencyDomainName No description.
resetAgencyName No description.
resetAlias No description.
resetAllowReauth No description.
resetAuthUrl No description.
resetBackoffRetryTimeout No description.
resetCacertFile No description.
resetCert No description.
resetCloud No description.
resetDelegatedProject No description.
resetDomainId No description.
resetDomainName No description.
resetEndpointType No description.
resetInsecure No description.
resetKey No description.
resetMaxBackoffRetries No description.
resetMaxRetries No description.
resetPasscode No description.
resetPassword No description.
resetRegion No description.
resetSecretKey No description.
resetSecurityToken No description.
resetSwauth No description.
resetTenantId No description.
resetTenantName No description.
resetToken No description.
resetUserId 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.

resetAccessKey 
public void resetAccessKey()
resetAgencyDomainName 
public void resetAgencyDomainName()
resetAgencyName 
public void resetAgencyName()
resetAlias 
public void resetAlias()
resetAllowReauth 
public void resetAllowReauth()
resetAuthUrl 
public void resetAuthUrl()
resetBackoffRetryTimeout 
public void resetBackoffRetryTimeout()
resetCacertFile 
public void resetCacertFile()
resetCert 
public void resetCert()
resetCloud 
public void resetCloud()
resetDelegatedProject 
public void resetDelegatedProject()
resetDomainId 
public void resetDomainId()
resetDomainName 
public void resetDomainName()
resetEndpointType 
public void resetEndpointType()
resetInsecure 
public void resetInsecure()
resetKey 
public void resetKey()
resetMaxBackoffRetries 
public void resetMaxBackoffRetries()
resetMaxRetries 
public void resetMaxRetries()
resetPasscode 
public void resetPasscode()
resetPassword 
public void resetPassword()
resetRegion 
public void resetRegion()
resetSecretKey 
public void resetSecretKey()
resetSecurityToken 
public void resetSecurityToken()
resetSwauth 
public void resetSwauth()
resetTenantId 
public void resetTenantId()
resetTenantName 
public void resetTenantName()
resetToken 
public void resetToken()
resetUserId 
public void resetUserId()
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 OpentelekomcloudProvider resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.opentelekomcloud.provider.OpentelekomcloudProvider;

OpentelekomcloudProvider.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.opentelekomcloud.provider.OpentelekomcloudProvider;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing OpentelekomcloudProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/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 OpentelekomcloudProvider 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.
accessKeyInput java.lang.String No description.
agencyDomainNameInput java.lang.String No description.
agencyNameInput java.lang.String No description.
aliasInput java.lang.String No description.
allowReauthInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
authUrlInput java.lang.String No description.
backoffRetryTimeoutInput java.lang.Number No description.
cacertFileInput java.lang.String No description.
certInput java.lang.String No description.
cloudInput java.lang.String No description.
delegatedProjectInput java.lang.String No description.
domainIdInput java.lang.String No description.
domainNameInput java.lang.String No description.
endpointTypeInput java.lang.String No description.
insecureInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
keyInput java.lang.String No description.
maxBackoffRetriesInput java.lang.Number No description.
maxRetriesInput java.lang.Number No description.
passcodeInput java.lang.String No description.
passwordInput java.lang.String No description.
regionInput java.lang.String No description.
secretKeyInput java.lang.String No description.
securityTokenInput java.lang.String No description.
swauthInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tenantIdInput java.lang.String No description.
tenantNameInput java.lang.String No description.
tokenInput java.lang.String No description.
userIdInput java.lang.String No description.
userNameInput java.lang.String No description.
accessKey java.lang.String No description.
agencyDomainName java.lang.String No description.
agencyName java.lang.String No description.
allowReauth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
authUrl java.lang.String No description.
backoffRetryTimeout java.lang.Number No description.
cacertFile java.lang.String No description.
cert java.lang.String No description.
cloud java.lang.String No description.
delegatedProject java.lang.String No description.
domainId java.lang.String No description.
domainName java.lang.String No description.
endpointType java.lang.String No description.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
key java.lang.String No description.
maxBackoffRetries java.lang.Number No description.
maxRetries java.lang.Number No description.
passcode java.lang.String No description.
password java.lang.String No description.
region java.lang.String No description.
secretKey java.lang.String No description.
securityToken java.lang.String No description.
swauth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tenantId java.lang.String No description.
tenantName java.lang.String No description.
token java.lang.String No description.
userId 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
accessKeyInputOptional 
public java.lang.String getAccessKeyInput();
  • Type: java.lang.String
agencyDomainNameInputOptional 
public java.lang.String getAgencyDomainNameInput();
  • Type: java.lang.String
agencyNameInputOptional 
public java.lang.String getAgencyNameInput();
  • Type: java.lang.String
aliasInputOptional 
public java.lang.String getAliasInput();
  • Type: java.lang.String
allowReauthInputOptional 
public java.lang.Object getAllowReauthInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
authUrlInputOptional 
public java.lang.String getAuthUrlInput();
  • Type: java.lang.String
backoffRetryTimeoutInputOptional 
public java.lang.Number getBackoffRetryTimeoutInput();
  • Type: java.lang.Number
cacertFileInputOptional 
public java.lang.String getCacertFileInput();
  • Type: java.lang.String
certInputOptional 
public java.lang.String getCertInput();
  • Type: java.lang.String
cloudInputOptional 
public java.lang.String getCloudInput();
  • Type: java.lang.String
delegatedProjectInputOptional 
public java.lang.String getDelegatedProjectInput();
  • Type: java.lang.String
domainIdInputOptional 
public java.lang.String getDomainIdInput();
  • Type: java.lang.String
domainNameInputOptional 
public java.lang.String getDomainNameInput();
  • Type: java.lang.String
endpointTypeInputOptional 
public java.lang.String getEndpointTypeInput();
  • Type: java.lang.String
insecureInputOptional 
public java.lang.Object getInsecureInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
keyInputOptional 
public java.lang.String getKeyInput();
  • Type: java.lang.String
maxBackoffRetriesInputOptional 
public java.lang.Number getMaxBackoffRetriesInput();
  • Type: java.lang.Number
maxRetriesInputOptional 
public java.lang.Number getMaxRetriesInput();
  • Type: java.lang.Number
passcodeInputOptional 
public java.lang.String getPasscodeInput();
  • Type: java.lang.String
passwordInputOptional 
public java.lang.String getPasswordInput();
  • Type: java.lang.String
regionInputOptional 
public java.lang.String getRegionInput();
  • Type: java.lang.String
secretKeyInputOptional 
public java.lang.String getSecretKeyInput();
  • Type: java.lang.String
securityTokenInputOptional 
public java.lang.String getSecurityTokenInput();
  • Type: java.lang.String
swauthInputOptional 
public java.lang.Object getSwauthInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tenantIdInputOptional 
public java.lang.String getTenantIdInput();
  • Type: java.lang.String
tenantNameInputOptional 
public java.lang.String getTenantNameInput();
  • Type: java.lang.String
tokenInputOptional 
public java.lang.String getTokenInput();
  • Type: java.lang.String
userIdInputOptional 
public java.lang.String getUserIdInput();
  • Type: java.lang.String
userNameInputOptional 
public java.lang.String getUserNameInput();
  • Type: java.lang.String
accessKeyOptional 
public java.lang.String getAccessKey();
  • Type: java.lang.String
agencyDomainNameOptional 
public java.lang.String getAgencyDomainName();
  • Type: java.lang.String
agencyNameOptional 
public java.lang.String getAgencyName();
  • Type: java.lang.String
allowReauthOptional 
public java.lang.Object getAllowReauth();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
authUrlOptional 
public java.lang.String getAuthUrl();
  • Type: java.lang.String
backoffRetryTimeoutOptional 
public java.lang.Number getBackoffRetryTimeout();
  • Type: java.lang.Number
cacertFileOptional 
public java.lang.String getCacertFile();
  • Type: java.lang.String
certOptional 
public java.lang.String getCert();
  • Type: java.lang.String
cloudOptional 
public java.lang.String getCloud();
  • Type: java.lang.String
delegatedProjectOptional 
public java.lang.String getDelegatedProject();
  • Type: java.lang.String
domainIdOptional 
public java.lang.String getDomainId();
  • Type: java.lang.String
domainNameOptional 
public java.lang.String getDomainName();
  • Type: java.lang.String
endpointTypeOptional 
public java.lang.String getEndpointType();
  • Type: java.lang.String
insecureOptional 
public java.lang.Object getInsecure();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
keyOptional 
public java.lang.String getKey();
  • Type: java.lang.String
maxBackoffRetriesOptional 
public java.lang.Number getMaxBackoffRetries();
  • Type: java.lang.Number
maxRetriesOptional 
public java.lang.Number getMaxRetries();
  • Type: java.lang.Number
passcodeOptional 
public java.lang.String getPasscode();
  • Type: java.lang.String
passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String
regionOptional 
public java.lang.String getRegion();
  • Type: java.lang.String
secretKeyOptional 
public java.lang.String getSecretKey();
  • Type: java.lang.String
securityTokenOptional 
public java.lang.String getSecurityToken();
  • Type: java.lang.String
swauthOptional 
public java.lang.Object getSwauth();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tenantIdOptional 
public java.lang.String getTenantId();
  • Type: java.lang.String
tenantNameOptional 
public java.lang.String getTenantName();
  • Type: java.lang.String
tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String
userIdOptional 
public java.lang.String getUserId();
  • 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

OpentelekomcloudProviderConfig

Initializer 

import com.hashicorp.cdktf.providers.opentelekomcloud.provider.OpentelekomcloudProviderConfig;

OpentelekomcloudProviderConfig.builder()
//  .accessKey(java.lang.String)
//  .agencyDomainName(java.lang.String)
//  .agencyName(java.lang.String)
//  .alias(java.lang.String)
//  .allowReauth(java.lang.Boolean)
//  .allowReauth(IResolvable)
//  .authUrl(java.lang.String)
//  .backoffRetryTimeout(java.lang.Number)
//  .cacertFile(java.lang.String)
//  .cert(java.lang.String)
//  .cloud(java.lang.String)
//  .delegatedProject(java.lang.String)
//  .domainId(java.lang.String)
//  .domainName(java.lang.String)
//  .endpointType(java.lang.String)
//  .insecure(java.lang.Boolean)
//  .insecure(IResolvable)
//  .key(java.lang.String)
//  .maxBackoffRetries(java.lang.Number)
//  .maxRetries(java.lang.Number)
//  .passcode(java.lang.String)
//  .password(java.lang.String)
//  .region(java.lang.String)
//  .secretKey(java.lang.String)
//  .securityToken(java.lang.String)
//  .swauth(java.lang.Boolean)
//  .swauth(IResolvable)
//  .tenantId(java.lang.String)
//  .tenantName(java.lang.String)
//  .token(java.lang.String)
//  .userId(java.lang.String)
//  .userName(java.lang.String)
    .build();

Properties

Name Type Description
accessKey java.lang.String The access key for API operations. You can retrieve this from the 'My Credential' section of the console.
agencyDomainName java.lang.String The name of domain who created the agency (Identity v3).
agencyName java.lang.String The name of agency.
alias java.lang.String Alias name.
allowReauth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#allow_reauth OpentelekomcloudProvider#allow_reauth}.
authUrl java.lang.String The Identity authentication URL.
backoffRetryTimeout java.lang.Number Timeout in seconds for backoff retry.
cacertFile java.lang.String A Custom CA certificate.
cert java.lang.String A client certificate to authenticate with.
cloud java.lang.String An entry in a clouds.yaml file to use.
delegatedProject java.lang.String The name of delegated project (Identity v3).
domainId java.lang.String The ID of the Domain to scope to (Identity v3).
domainName java.lang.String The name of the Domain to scope to (Identity v3).
endpointType java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#endpoint_type OpentelekomcloudProvider#endpoint_type}.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Trust self-signed certificates.
key java.lang.String A client private key to authenticate with.
maxBackoffRetries java.lang.Number How many times HTTP request should be retried when rate limit reached.
maxRetries java.lang.Number How many times HTTP connection should be retried until giving up.
passcode java.lang.String One-time MFA passcode.
password java.lang.String Password to login with.
region java.lang.String The OpenTelekomCloud region to connect to.
secretKey java.lang.String The secret key for API operations. You can retrieve this from the 'My Credential' section of the console.
securityToken java.lang.String Security token to use for OBS federated authentication.
swauth java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Use Swift's authentication system instead of Keystone. Only used for interaction with Swift.
tenantId java.lang.String The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
tenantName java.lang.String The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
token java.lang.String Authentication token to use as an alternative to username/password.
userId java.lang.String User ID to login with.
userName java.lang.String Username to login with.
accessKeyOptional 
public java.lang.String getAccessKey();
  • Type: java.lang.String

The access key for API operations. You can retrieve this from the 'My Credential' section of the console.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#access_key OpentelekomcloudProvider#access_key}

agencyDomainNameOptional 
public java.lang.String getAgencyDomainName();
  • Type: java.lang.String

The name of domain who created the agency (Identity v3).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#agency_domain_name OpentelekomcloudProvider#agency_domain_name}

agencyNameOptional 
public java.lang.String getAgencyName();
  • Type: java.lang.String

The name of agency.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#agency_name OpentelekomcloudProvider#agency_name}

aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#alias OpentelekomcloudProvider#alias}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#allow_reauth OpentelekomcloudProvider#allow_reauth}.

authUrlOptional 
public java.lang.String getAuthUrl();
  • Type: java.lang.String

The Identity authentication URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#auth_url OpentelekomcloudProvider#auth_url}

backoffRetryTimeoutOptional 
public java.lang.Number getBackoffRetryTimeout();
  • Type: java.lang.Number

Timeout in seconds for backoff retry.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#backoff_retry_timeout OpentelekomcloudProvider#backoff_retry_timeout}

cacertFileOptional 
public java.lang.String getCacertFile();
  • Type: java.lang.String

A Custom CA certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#cacert_file OpentelekomcloudProvider#cacert_file}

certOptional 
public java.lang.String getCert();
  • Type: java.lang.String

A client certificate to authenticate with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#cert OpentelekomcloudProvider#cert}

cloudOptional 
public java.lang.String getCloud();
  • Type: java.lang.String

An entry in a clouds.yaml file to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#cloud OpentelekomcloudProvider#cloud}

delegatedProjectOptional 
public java.lang.String getDelegatedProject();
  • Type: java.lang.String

The name of delegated project (Identity v3).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#delegated_project OpentelekomcloudProvider#delegated_project}

domainIdOptional 
public java.lang.String getDomainId();
  • Type: java.lang.String

The ID of the Domain to scope to (Identity v3).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#domain_id OpentelekomcloudProvider#domain_id}

domainNameOptional 
public java.lang.String getDomainName();
  • Type: java.lang.String

The name of the Domain to scope to (Identity v3).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#domain_name OpentelekomcloudProvider#domain_name}

endpointTypeOptional 
public java.lang.String getEndpointType();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#endpoint_type OpentelekomcloudProvider#endpoint_type}.

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

Trust self-signed certificates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#insecure OpentelekomcloudProvider#insecure}

keyOptional 
public java.lang.String getKey();
  • Type: java.lang.String

A client private key to authenticate with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#key OpentelekomcloudProvider#key}

maxBackoffRetriesOptional 
public java.lang.Number getMaxBackoffRetries();
  • Type: java.lang.Number

How many times HTTP request should be retried when rate limit reached.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#max_backoff_retries OpentelekomcloudProvider#max_backoff_retries}

maxRetriesOptional 
public java.lang.Number getMaxRetries();
  • Type: java.lang.Number

How many times HTTP connection should be retried until giving up.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#max_retries OpentelekomcloudProvider#max_retries}

passcodeOptional 
public java.lang.String getPasscode();
  • Type: java.lang.String

One-time MFA passcode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#passcode OpentelekomcloudProvider#passcode}

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

Password to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#password OpentelekomcloudProvider#password}

regionOptional 
public java.lang.String getRegion();
  • Type: java.lang.String

The OpenTelekomCloud region to connect to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#region OpentelekomcloudProvider#region}

secretKeyOptional 
public java.lang.String getSecretKey();
  • Type: java.lang.String

The secret key for API operations. You can retrieve this from the 'My Credential' section of the console.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#secret_key OpentelekomcloudProvider#secret_key}

securityTokenOptional 
public java.lang.String getSecurityToken();
  • Type: java.lang.String

Security token to use for OBS federated authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#security_token OpentelekomcloudProvider#security_token}

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

Use Swift's authentication system instead of Keystone. Only used for interaction with Swift.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#swauth OpentelekomcloudProvider#swauth}

tenantIdOptional 
public java.lang.String getTenantId();
  • Type: java.lang.String

The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#tenant_id OpentelekomcloudProvider#tenant_id}

tenantNameOptional 
public java.lang.String getTenantName();
  • Type: java.lang.String

The name of the Tenant (Identity v2) or Project (Identity v3) to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#tenant_name OpentelekomcloudProvider#tenant_name}

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

Authentication token to use as an alternative to username/password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#token OpentelekomcloudProvider#token}

userIdOptional 
public java.lang.String getUserId();
  • Type: java.lang.String

User ID to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#user_id OpentelekomcloudProvider#user_id}

userNameOptional 
public java.lang.String getUserName();
  • Type: java.lang.String

Username to login with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.8/docs#user_name OpentelekomcloudProvider#user_name}