com.hashicorp.cdktf

Class AzurermBackendConfig.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

com.hashicorp.cdktf.AzurermBackendConfig.Jsii$Proxy

All Implemented Interfaces:

AzurermBackendConfig, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AzurermBackendConfig

@Stability(value=Experimental)
 @Internal
public static final class AzurermBackendConfig.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements AzurermBackendConfig

An implementation for AzurermBackendConfig

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface com.hashicorp.cdktf.AzurermBackendConfig

AzurermBackendConfig.Builder, AzurermBackendConfig.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(AzurermBackendConfig.Builder builder) Constructor that initializes the object based on literal property values passed by the AzurermBackendConfig.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getAccessKey() (experimental) access_key - (Optional) The Access Key used to access the Blob Storage Account.
String	getClientCertificatePassword() (experimental) (Optional) The password associated with the Client Certificate specified in client_certificate_path.
String	getClientCertificatePath() (experimental) (Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal.
String	getClientId() (experimental) (Optional) The Client ID of the Service Principal.
String	getClientSecret() (experimental) (Optional) The Client Secret of the Service Principal.
String	getContainerName() (experimental) (Required) The Name of the Storage Container within the Storage Account.
String	getEndpoint() (experimental) (Optional) The Custom Endpoint for Azure Resource Manager.
String	getEnvironment() (experimental) (Optional) The Azure Environment which should be used.
String	getKey() (experimental) (Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container.
String	getMsiEndpoint() (experimental) (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.
String	getOidcRequestToken() (experimental) (Optional) The bearer token for the request to the OIDC provider.
String	getOidcRequestUrl() (experimental) (Optional) The URL for the OIDC provider from which to request an ID token.
String	getResourceGroupName() (experimental) (Required) The Name of the Resource Group in which the Storage Account exists.
String	getSasToken() (experimental) (Optional) The SAS Token used to access the Blob Storage Account.
Boolean	getSnapshot() (experimental) (Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use?
String	getStorageAccountName() (experimental) (Required) The Name of the Storage Account.
String	getSubscriptionId() (experimental) (Optional) The Subscription ID in which the Storage Account exists.
String	getTenantId() (experimental) (Optional) The Tenant ID in which the Subscription exists.
Boolean	getUseAzureadAuth() (experimental) (Optional) Should AzureAD Authentication be used to access the Blob Storage Account.
Boolean	getUseMicrosoftGraph() (experimental) (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph?
Boolean	getUseMsi() (experimental) (Optional) Should Managed Service Identity authentication be used?
Boolean	getUseOidc() (experimental) (Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hashicorp.cdktf.AzurermBackendConfig

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(AzurermBackendConfig.Builder builder)

Constructor that initializes the object based on literal property values passed by the AzurermBackendConfig.Builder.

Method Detail

getContainerName

public final String getContainerName()

Description copied from interface: AzurermBackendConfig

(experimental) (Required) The Name of the Storage Container within the Storage Account.

Specified by:

getContainerName in interface AzurermBackendConfig

getKey

public final String getKey()

Description copied from interface: AzurermBackendConfig

(experimental) (Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container.

Specified by:

getKey in interface AzurermBackendConfig

getStorageAccountName

public final String getStorageAccountName()

Description copied from interface: AzurermBackendConfig

(experimental) (Required) The Name of the Storage Account.

Specified by:

getStorageAccountName in interface AzurermBackendConfig

getAccessKey

public final String getAccessKey()

Description copied from interface: AzurermBackendConfig

(experimental) access_key - (Optional) The Access Key used to access the Blob Storage Account.

This can also be sourced from the ARM_ACCESS_KEY environment variable.

Specified by:

getAccessKey in interface AzurermBackendConfig

getClientCertificatePassword

public final String getClientCertificatePassword()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The password associated with the Client Certificate specified in client_certificate_path.

This can also be sourced from the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable.

Specified by:

getClientCertificatePassword in interface AzurermBackendConfig

getClientCertificatePath

public final String getClientCertificatePath()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal.

This can also be sourced from the ARM_CLIENT_CERTIFICATE_PATH environment variable.

Specified by:

getClientCertificatePath in interface AzurermBackendConfig

getClientId

public final String getClientId()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The Client ID of the Service Principal.

This can also be sourced from the ARM_CLIENT_ID environment variable.

Specified by:

getClientId in interface AzurermBackendConfig

getClientSecret

public final String getClientSecret()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The Client Secret of the Service Principal.

This can also be sourced from the ARM_CLIENT_SECRET environment variable.

Specified by:

getClientSecret in interface AzurermBackendConfig

getEndpoint

public final String getEndpoint()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable.

NOTE: An endpoint should only be configured when using Azure Stack.

Specified by:

getEndpoint in interface AzurermBackendConfig

getEnvironment

public final String getEnvironment()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The Azure Environment which should be used.

This can also be sourced from the ARM_ENVIRONMENT environment variable. Possible values are public, china, german, stack and usgovernment. Defaults to public.

Specified by:

getEnvironment in interface AzurermBackendConfig

getMsiEndpoint

public final String getMsiEndpoint()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.

This can also be sourced from the ARM_MSI_ENDPOINT environment variable.

Specified by:

getMsiEndpoint in interface AzurermBackendConfig

getOidcRequestToken

public final String getOidcRequestToken()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The bearer token for the request to the OIDC provider.

This can also be sourced from the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables.

Specified by:

getOidcRequestToken in interface AzurermBackendConfig

getOidcRequestUrl

public final String getOidcRequestUrl()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The URL for the OIDC provider from which to request an ID token.

This can also be sourced from the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables.

Specified by:

getOidcRequestUrl in interface AzurermBackendConfig

getResourceGroupName

public final String getResourceGroupName()

Description copied from interface: AzurermBackendConfig

(experimental) (Required) The Name of the Resource Group in which the Storage Account exists.

Specified by:

getResourceGroupName in interface AzurermBackendConfig

getSasToken

public final String getSasToken()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The SAS Token used to access the Blob Storage Account.

This can also be sourced from the ARM_SAS_TOKEN environment variable.

Specified by:

getSasToken in interface AzurermBackendConfig

getSnapshot

public final Boolean getSnapshot()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use?

Defaults to false. This value can also be sourced from the ARM_SNAPSHOT environment variable.

Specified by:

getSnapshot in interface AzurermBackendConfig

getSubscriptionId

public final String getSubscriptionId()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The Subscription ID in which the Storage Account exists.

This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.

Specified by:

getSubscriptionId in interface AzurermBackendConfig

getTenantId

public final String getTenantId()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) The Tenant ID in which the Subscription exists.

This can also be sourced from the ARM_TENANT_ID environment variable.

Specified by:

getTenantId in interface AzurermBackendConfig

getUseAzureadAuth

public final Boolean getUseAzureadAuth()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) Should AzureAD Authentication be used to access the Blob Storage Account.

This can also be sourced from the ARM_USE_AZUREAD environment variable.

Note: When using AzureAD for Authentication to Storage you also need to ensure the Storage Blob Data Owner role is assigned.

Specified by:

getUseAzureadAuth in interface AzurermBackendConfig

getUseMicrosoftGraph

public final Boolean getUseMicrosoftGraph()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph?

Defaults to true.

Note: In Terraform 1.2 the Azure Backend uses MSAL (and Microsoft Graph) rather than ADAL (and Azure Active Directory Graph) for authentication by default - you can disable this by setting use_microsoft_graph to false. This setting will be removed in Terraform 1.3, due to Microsoft's deprecation of ADAL.

Specified by:

getUseMicrosoftGraph in interface AzurermBackendConfig

getUseMsi

public final Boolean getUseMsi()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) Should Managed Service Identity authentication be used?

This can also be sourced from the ARM_USE_MSI environment variable.

Specified by:

getUseMsi in interface AzurermBackendConfig

getUseOidc

public final Boolean getUseOidc()

Description copied from interface: AzurermBackendConfig

(experimental) (Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable.

Note: When using OIDC for authentication, use_microsoft_graph must be set to true (which is the default).

Specified by:

getUseOidc in interface AzurermBackendConfig

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object