Skip to content

Latest commit

 

History

History
1510 lines (949 loc) · 70.8 KB

provider.java.md

File metadata and controls

1510 lines (949 loc) · 70.8 KB
Raw

provider Submodule

Constructs

AzurestackProvider

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

Initializers 

import com.hashicorp.cdktf.providers.azurestack.provider.AzurestackProvider;

AzurestackProvider.Builder.create(Construct scope, java.lang.String id)
    .features(AzurestackProviderFeatures)
//  .alias(java.lang.String)
//  .armEndpoint(java.lang.String)
//  .auxiliaryTenantIds(java.util.List<java.lang.String>)
//  .clientCertificatePassword(java.lang.String)
//  .clientCertificatePath(java.lang.String)
//  .clientId(java.lang.String)
//  .clientSecret(java.lang.String)
//  .disableCorrelationRequestId(java.lang.Boolean)
//  .disableCorrelationRequestId(IResolvable)
//  .environment(java.lang.String)
//  .metadataHost(java.lang.String)
//  .msiEndpoint(java.lang.String)
//  .skipProviderRegistration(java.lang.Boolean)
//  .skipProviderRegistration(IResolvable)
//  .subscriptionId(java.lang.String)
//  .tenantId(java.lang.String)
//  .useMsi(java.lang.Boolean)
//  .useMsi(IResolvable)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
features AzurestackProviderFeatures features block.
alias java.lang.String Alias name.
armEndpoint java.lang.String The Hostname which should be used for the Azure Metadata Service.
auxiliaryTenantIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#auxiliary_tenant_ids AzurestackProvider#auxiliary_tenant_ids}.
clientCertificatePassword java.lang.String The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate.
clientCertificatePath java.lang.String The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
clientId java.lang.String The Client ID which should be used.
clientSecret java.lang.String The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disableCorrelationRequestId java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This will disable the x-ms-correlation-request-id header.
environment java.lang.String The Cloud Environment which should be used.
metadataHost java.lang.String The Hostname which should be used for the Azure Metadata Service.
msiEndpoint java.lang.String The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
skipProviderRegistration java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Should the AzureStack Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
subscriptionId java.lang.String The Subscription ID which should be used.
tenantId java.lang.String The Tenant ID which should be used.
useMsi java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Allowed Managed Service Identity be used for Authentication.
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

featuresRequired

features block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#features AzurestackProvider#features}

aliasOptional
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#alias AzurestackProvider#alias}

armEndpointOptional
  • Type: java.lang.String

The Hostname which should be used for the Azure Metadata Service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#arm_endpoint AzurestackProvider#arm_endpoint}

auxiliaryTenantIdsOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#auxiliary_tenant_ids AzurestackProvider#auxiliary_tenant_ids}.

clientCertificatePasswordOptional
  • Type: java.lang.String

The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#client_certificate_password AzurestackProvider#client_certificate_password}

clientCertificatePathOptional
  • Type: java.lang.String

The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#client_certificate_path AzurestackProvider#client_certificate_path}

clientIdOptional
  • Type: java.lang.String

The Client ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#client_id AzurestackProvider#client_id}

clientSecretOptional
  • Type: java.lang.String

The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#client_secret AzurestackProvider#client_secret}

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

This will disable the x-ms-correlation-request-id header.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#disable_correlation_request_id AzurestackProvider#disable_correlation_request_id}

environmentOptional
  • Type: java.lang.String

The Cloud Environment which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#environment AzurestackProvider#environment}

metadataHostOptional
  • Type: java.lang.String

The Hostname which should be used for the Azure Metadata Service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#metadata_host AzurestackProvider#metadata_host}

msiEndpointOptional
  • Type: java.lang.String

The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#msi_endpoint AzurestackProvider#msi_endpoint}

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

Should the AzureStack Provider skip registering all of the Resource Providers that it supports, if they're not already registered?

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#skip_provider_registration AzurestackProvider#skip_provider_registration}

subscriptionIdOptional
  • Type: java.lang.String

The Subscription ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#subscription_id AzurestackProvider#subscription_id}

tenantIdOptional
  • Type: java.lang.String

The Tenant ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#tenant_id AzurestackProvider#tenant_id}

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

Allowed Managed Service Identity be used for Authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#use_msi AzurestackProvider#use_msi}

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.
resetArmEndpoint No description.
resetAuxiliaryTenantIds No description.
resetClientCertificatePassword No description.
resetClientCertificatePath No description.
resetClientId No description.
resetClientSecret No description.
resetDisableCorrelationRequestId No description.
resetEnvironment No description.
resetMetadataHost No description.
resetMsiEndpoint No description.
resetSkipProviderRegistration No description.
resetSubscriptionId No description.
resetTenantId No description.
resetUseMsi 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()
resetArmEndpoint 
public void resetArmEndpoint()
resetAuxiliaryTenantIds 
public void resetAuxiliaryTenantIds()
resetClientCertificatePassword 
public void resetClientCertificatePassword()
resetClientCertificatePath 
public void resetClientCertificatePath()
resetClientId 
public void resetClientId()
resetClientSecret 
public void resetClientSecret()
resetDisableCorrelationRequestId 
public void resetDisableCorrelationRequestId()
resetEnvironment 
public void resetEnvironment()
resetMetadataHost 
public void resetMetadataHost()
resetMsiEndpoint 
public void resetMsiEndpoint()
resetSkipProviderRegistration 
public void resetSkipProviderRegistration()
resetSubscriptionId 
public void resetSubscriptionId()
resetTenantId 
public void resetTenantId()
resetUseMsi 
public void resetUseMsi()

Static Functions

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

AzurestackProvider.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.azurestack.provider.AzurestackProvider;

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

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

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing AzurestackProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/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 AzurestackProvider 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.
armEndpointInput java.lang.String No description.
auxiliaryTenantIdsInput java.util.List<java.lang.String> No description.
clientCertificatePasswordInput java.lang.String No description.
clientCertificatePathInput java.lang.String No description.
clientIdInput java.lang.String No description.
clientSecretInput java.lang.String No description.
disableCorrelationRequestIdInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
environmentInput java.lang.String No description.
featuresInput AzurestackProviderFeatures No description.
metadataHostInput java.lang.String No description.
msiEndpointInput java.lang.String No description.
skipProviderRegistrationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
subscriptionIdInput java.lang.String No description.
tenantIdInput java.lang.String No description.
useMsiInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
armEndpoint java.lang.String No description.
auxiliaryTenantIds java.util.List<java.lang.String> No description.
clientCertificatePassword java.lang.String No description.
clientCertificatePath java.lang.String No description.
clientId java.lang.String No description.
clientSecret java.lang.String No description.
disableCorrelationRequestId java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
environment java.lang.String No description.
features AzurestackProviderFeatures No description.
metadataHost java.lang.String No description.
msiEndpoint java.lang.String No description.
skipProviderRegistration java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
subscriptionId java.lang.String No description.
tenantId java.lang.String No description.
useMsi java.lang.Boolean OR com.hashicorp.cdktf.IResolvable 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
armEndpointInputOptional 
public java.lang.String getArmEndpointInput();
  • Type: java.lang.String
auxiliaryTenantIdsInputOptional 
public java.util.List<java.lang.String> getAuxiliaryTenantIdsInput();
  • Type: java.util.List<java.lang.String>
clientCertificatePasswordInputOptional 
public java.lang.String getClientCertificatePasswordInput();
  • Type: java.lang.String
clientCertificatePathInputOptional 
public java.lang.String getClientCertificatePathInput();
  • Type: java.lang.String
clientIdInputOptional 
public java.lang.String getClientIdInput();
  • Type: java.lang.String
clientSecretInputOptional 
public java.lang.String getClientSecretInput();
  • Type: java.lang.String
disableCorrelationRequestIdInputOptional 
public java.lang.Object getDisableCorrelationRequestIdInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
environmentInputOptional 
public java.lang.String getEnvironmentInput();
  • Type: java.lang.String
featuresInputOptional 
public AzurestackProviderFeatures getFeaturesInput();
metadataHostInputOptional 
public java.lang.String getMetadataHostInput();
  • Type: java.lang.String
msiEndpointInputOptional 
public java.lang.String getMsiEndpointInput();
  • Type: java.lang.String
skipProviderRegistrationInputOptional 
public java.lang.Object getSkipProviderRegistrationInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
subscriptionIdInputOptional 
public java.lang.String getSubscriptionIdInput();
  • Type: java.lang.String
tenantIdInputOptional 
public java.lang.String getTenantIdInput();
  • Type: java.lang.String
useMsiInputOptional 
public java.lang.Object getUseMsiInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
armEndpointOptional 
public java.lang.String getArmEndpoint();
  • Type: java.lang.String
auxiliaryTenantIdsOptional 
public java.util.List<java.lang.String> getAuxiliaryTenantIds();
  • Type: java.util.List<java.lang.String>
clientCertificatePasswordOptional 
public java.lang.String getClientCertificatePassword();
  • Type: java.lang.String
clientCertificatePathOptional 
public java.lang.String getClientCertificatePath();
  • Type: java.lang.String
clientIdOptional 
public java.lang.String getClientId();
  • Type: java.lang.String
clientSecretOptional 
public java.lang.String getClientSecret();
  • Type: java.lang.String
disableCorrelationRequestIdOptional 
public java.lang.Object getDisableCorrelationRequestId();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
environmentOptional 
public java.lang.String getEnvironment();
  • Type: java.lang.String
featuresOptional 
public AzurestackProviderFeatures getFeatures();
metadataHostOptional 
public java.lang.String getMetadataHost();
  • Type: java.lang.String
msiEndpointOptional 
public java.lang.String getMsiEndpoint();
  • Type: java.lang.String
skipProviderRegistrationOptional 
public java.lang.Object getSkipProviderRegistration();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
subscriptionIdOptional 
public java.lang.String getSubscriptionId();
  • Type: java.lang.String
tenantIdOptional 
public java.lang.String getTenantId();
  • Type: java.lang.String
useMsiOptional 
public java.lang.Object getUseMsi();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Constants

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

Structs

AzurestackProviderConfig

Initializer 

import com.hashicorp.cdktf.providers.azurestack.provider.AzurestackProviderConfig;

AzurestackProviderConfig.builder()
    .features(AzurestackProviderFeatures)
//  .alias(java.lang.String)
//  .armEndpoint(java.lang.String)
//  .auxiliaryTenantIds(java.util.List<java.lang.String>)
//  .clientCertificatePassword(java.lang.String)
//  .clientCertificatePath(java.lang.String)
//  .clientId(java.lang.String)
//  .clientSecret(java.lang.String)
//  .disableCorrelationRequestId(java.lang.Boolean)
//  .disableCorrelationRequestId(IResolvable)
//  .environment(java.lang.String)
//  .metadataHost(java.lang.String)
//  .msiEndpoint(java.lang.String)
//  .skipProviderRegistration(java.lang.Boolean)
//  .skipProviderRegistration(IResolvable)
//  .subscriptionId(java.lang.String)
//  .tenantId(java.lang.String)
//  .useMsi(java.lang.Boolean)
//  .useMsi(IResolvable)
    .build();

Properties

Name Type Description
features AzurestackProviderFeatures features block.
alias java.lang.String Alias name.
armEndpoint java.lang.String The Hostname which should be used for the Azure Metadata Service.
auxiliaryTenantIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#auxiliary_tenant_ids AzurestackProvider#auxiliary_tenant_ids}.
clientCertificatePassword java.lang.String The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate.
clientCertificatePath java.lang.String The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
clientId java.lang.String The Client ID which should be used.
clientSecret java.lang.String The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disableCorrelationRequestId java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This will disable the x-ms-correlation-request-id header.
environment java.lang.String The Cloud Environment which should be used.
metadataHost java.lang.String The Hostname which should be used for the Azure Metadata Service.
msiEndpoint java.lang.String The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
skipProviderRegistration java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Should the AzureStack Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
subscriptionId java.lang.String The Subscription ID which should be used.
tenantId java.lang.String The Tenant ID which should be used.
useMsi java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Allowed Managed Service Identity be used for Authentication.
featuresRequired 
public AzurestackProviderFeatures getFeatures();

features block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#features AzurestackProvider#features}

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

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#alias AzurestackProvider#alias}

armEndpointOptional 
public java.lang.String getArmEndpoint();
  • Type: java.lang.String

The Hostname which should be used for the Azure Metadata Service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#arm_endpoint AzurestackProvider#arm_endpoint}

auxiliaryTenantIdsOptional 
public java.util.List<java.lang.String> getAuxiliaryTenantIds();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#auxiliary_tenant_ids AzurestackProvider#auxiliary_tenant_ids}.

clientCertificatePasswordOptional 
public java.lang.String getClientCertificatePassword();
  • Type: java.lang.String

The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#client_certificate_password AzurestackProvider#client_certificate_password}

clientCertificatePathOptional 
public java.lang.String getClientCertificatePath();
  • Type: java.lang.String

The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#client_certificate_path AzurestackProvider#client_certificate_path}

clientIdOptional 
public java.lang.String getClientId();
  • Type: java.lang.String

The Client ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#client_id AzurestackProvider#client_id}

clientSecretOptional 
public java.lang.String getClientSecret();
  • Type: java.lang.String

The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#client_secret AzurestackProvider#client_secret}

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

This will disable the x-ms-correlation-request-id header.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#disable_correlation_request_id AzurestackProvider#disable_correlation_request_id}

environmentOptional 
public java.lang.String getEnvironment();
  • Type: java.lang.String

The Cloud Environment which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#environment AzurestackProvider#environment}

metadataHostOptional 
public java.lang.String getMetadataHost();
  • Type: java.lang.String

The Hostname which should be used for the Azure Metadata Service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#metadata_host AzurestackProvider#metadata_host}

msiEndpointOptional 
public java.lang.String getMsiEndpoint();
  • Type: java.lang.String

The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#msi_endpoint AzurestackProvider#msi_endpoint}

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

Should the AzureStack Provider skip registering all of the Resource Providers that it supports, if they're not already registered?

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#skip_provider_registration AzurestackProvider#skip_provider_registration}

subscriptionIdOptional 
public java.lang.String getSubscriptionId();
  • Type: java.lang.String

The Subscription ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#subscription_id AzurestackProvider#subscription_id}

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

The Tenant ID which should be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#tenant_id AzurestackProvider#tenant_id}

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

Allowed Managed Service Identity be used for Authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#use_msi AzurestackProvider#use_msi}

AzurestackProviderFeatures

Initializer 

import com.hashicorp.cdktf.providers.azurestack.provider.AzurestackProviderFeatures;

AzurestackProviderFeatures.builder()
//  .resourceGroup(AzurestackProviderFeaturesResourceGroup)
//  .virtualMachine(AzurestackProviderFeaturesVirtualMachine)
//  .virtualMachineScaleSet(AzurestackProviderFeaturesVirtualMachineScaleSet)
    .build();

Properties

Name Type Description
resourceGroup AzurestackProviderFeaturesResourceGroup resource_group block.
virtualMachine AzurestackProviderFeaturesVirtualMachine virtual_machine block.
virtualMachineScaleSet AzurestackProviderFeaturesVirtualMachineScaleSet virtual_machine_scale_set block.
resourceGroupOptional 
public AzurestackProviderFeaturesResourceGroup getResourceGroup();

resource_group block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#resource_group AzurestackProvider#resource_group}

virtualMachineOptional 
public AzurestackProviderFeaturesVirtualMachine getVirtualMachine();

virtual_machine block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#virtual_machine AzurestackProvider#virtual_machine}

virtualMachineScaleSetOptional 
public AzurestackProviderFeaturesVirtualMachineScaleSet getVirtualMachineScaleSet();

virtual_machine_scale_set block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#virtual_machine_scale_set AzurestackProvider#virtual_machine_scale_set}

AzurestackProviderFeaturesResourceGroup

Initializer 

import com.hashicorp.cdktf.providers.azurestack.provider.AzurestackProviderFeaturesResourceGroup;

AzurestackProviderFeaturesResourceGroup.builder()
//  .preventDeletionIfContainsResources(java.lang.Boolean)
//  .preventDeletionIfContainsResources(IResolvable)
    .build();

Properties

Name Type Description
preventDeletionIfContainsResources java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#prevent_deletion_if_contains_resources AzurestackProvider#prevent_deletion_if_contains_resources}.
preventDeletionIfContainsResourcesOptional 
public java.lang.Object getPreventDeletionIfContainsResources();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#prevent_deletion_if_contains_resources AzurestackProvider#prevent_deletion_if_contains_resources}.

AzurestackProviderFeaturesVirtualMachine

Initializer 

import com.hashicorp.cdktf.providers.azurestack.provider.AzurestackProviderFeaturesVirtualMachine;

AzurestackProviderFeaturesVirtualMachine.builder()
//  .deleteOsDiskOnDeletion(java.lang.Boolean)
//  .deleteOsDiskOnDeletion(IResolvable)
//  .gracefulShutdown(java.lang.Boolean)
//  .gracefulShutdown(IResolvable)
//  .skipShutdownAndForceDelete(java.lang.Boolean)
//  .skipShutdownAndForceDelete(IResolvable)
    .build();

Properties

Name Type Description
deleteOsDiskOnDeletion java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#delete_os_disk_on_deletion AzurestackProvider#delete_os_disk_on_deletion}.
gracefulShutdown java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#graceful_shutdown AzurestackProvider#graceful_shutdown}.
skipShutdownAndForceDelete java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#skip_shutdown_and_force_delete AzurestackProvider#skip_shutdown_and_force_delete}.
deleteOsDiskOnDeletionOptional 
public java.lang.Object getDeleteOsDiskOnDeletion();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#delete_os_disk_on_deletion AzurestackProvider#delete_os_disk_on_deletion}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#graceful_shutdown AzurestackProvider#graceful_shutdown}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#skip_shutdown_and_force_delete AzurestackProvider#skip_shutdown_and_force_delete}.

AzurestackProviderFeaturesVirtualMachineScaleSet

Initializer 

import com.hashicorp.cdktf.providers.azurestack.provider.AzurestackProviderFeaturesVirtualMachineScaleSet;

AzurestackProviderFeaturesVirtualMachineScaleSet.builder()
    .rollInstancesWhenRequired(java.lang.Boolean)
    .rollInstancesWhenRequired(IResolvable)
//  .forceDelete(java.lang.Boolean)
//  .forceDelete(IResolvable)
//  .scaleToZeroBeforeDeletion(java.lang.Boolean)
//  .scaleToZeroBeforeDeletion(IResolvable)
    .build();

Properties

Name Type Description
rollInstancesWhenRequired java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#roll_instances_when_required AzurestackProvider#roll_instances_when_required}.
forceDelete java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#force_delete AzurestackProvider#force_delete}.
scaleToZeroBeforeDeletion java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#scale_to_zero_before_deletion AzurestackProvider#scale_to_zero_before_deletion}.
rollInstancesWhenRequiredRequired 
public java.lang.Object getRollInstancesWhenRequired();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#roll_instances_when_required AzurestackProvider#roll_instances_when_required}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#force_delete AzurestackProvider#force_delete}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurestack/1.0.0/docs#scale_to_zero_before_deletion AzurestackProvider#scale_to_zero_before_deletion}.