com.hashicorp.cdktf

Class AzurermBackend.Builder

java.lang.Object

com.hashicorp.cdktf.AzurermBackend.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AzurermBackend>

Enclosing class:

AzurermBackend

@Stability(value=Experimental)
public static final class AzurermBackend.Builder
extends Object
implements software.amazon.jsii.Builder<AzurermBackend>

(experimental) A fluent builder for AzurermBackend.

Method Summary

Modifier and Type	Method and Description
AzurermBackend.Builder	accessKey(String accessKey) (experimental) access_key - (Optional) The Access Key used to access the Blob Storage Account.
AzurermBackend	build()
AzurermBackend.Builder	clientId(String clientId) (experimental) (Optional) The Client ID of the Service Principal.
AzurermBackend.Builder	clientSecret(String clientSecret) (experimental) (Optional) The Client Secret of the Service Principal.
AzurermBackend.Builder	containerName(String containerName) (experimental) (Required) The Name of the Storage Container within the Storage Account.
static AzurermBackend.Builder	create(software.constructs.Construct scope)
AzurermBackend.Builder	endpoint(String endpoint) (experimental) (Optional) The Custom Endpoint for Azure Resource Manager.
AzurermBackend.Builder	environment(String environment) (experimental) (Optional) The Azure Environment which should be used.
AzurermBackend.Builder	key(String key) (experimental) (Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container.
AzurermBackend.Builder	msiEndpoint(String msiEndpoint) (experimental) (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.
AzurermBackend.Builder	resourceGroupName(String resourceGroupName) (experimental) (Required) The Name of the Resource Group in which the Storage Account exists.
AzurermBackend.Builder	sasToken(String sasToken) (experimental) (Optional) The SAS Token used to access the Blob Storage Account.
AzurermBackend.Builder	storageAccountName(String storageAccountName) (experimental) (Required) The Name of the Storage Account.
AzurermBackend.Builder	subscriptionId(String subscriptionId) (experimental) (Optional) The Subscription ID in which the Storage Account exists.
AzurermBackend.Builder	tenantId(String tenantId) (experimental) (Optional) The Tenant ID in which the Subscription exists.
AzurermBackend.Builder	useMsi(Boolean useMsi) (experimental) (Optional) Should Managed Service Identity authentication be used?

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static AzurermBackend.Builder create(software.constructs.Construct scope)

Parameters:

scope - This parameter is required.

Returns:

a new instance of AzurermBackend.Builder.

containerName

@Stability(value=Experimental)
public AzurermBackend.Builder containerName(String containerName)

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

Parameters:

containerName - (Required) The Name of the Storage Container within the Storage Account. This parameter is required.

Returns:

this

key

@Stability(value=Experimental)
public AzurermBackend.Builder key(String key)

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

Parameters:

key - (Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container. This parameter is required.

Returns:

this

storageAccountName

@Stability(value=Experimental)
public AzurermBackend.Builder storageAccountName(String storageAccountName)

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

Parameters:

storageAccountName - (Required) The Name of the Storage Account. This parameter is required.

Returns:

this

accessKey

@Stability(value=Experimental)
public AzurermBackend.Builder accessKey(String accessKey)

(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.

Parameters:

accessKey - access_key - (Optional) The Access Key used to access the Blob Storage Account. This parameter is required.

Returns:

this

clientId

@Stability(value=Experimental)
public AzurermBackend.Builder clientId(String clientId)

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

This can also be sourced from the ARM_CLIENT_ID environment variable.

Parameters:

clientId - (Optional) The Client ID of the Service Principal. This parameter is required.

Returns:

this

clientSecret

@Stability(value=Experimental)
public AzurermBackend.Builder clientSecret(String clientSecret)

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

This can also be sourced from the ARM_CLIENT_SECRET environment variable.

Parameters:

clientSecret - (Optional) The Client Secret of the Service Principal. This parameter is required.

Returns:

this

endpoint

@Stability(value=Experimental)
public AzurermBackend.Builder endpoint(String endpoint)

(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.

Parameters:

endpoint - (Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable. This parameter is required.

Returns:

this

environment

@Stability(value=Experimental)
public AzurermBackend.Builder environment(String environment)

(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.

Parameters:

environment - (Optional) The Azure Environment which should be used. This parameter is required.

Returns:

this

msiEndpoint

@Stability(value=Experimental)
public AzurermBackend.Builder msiEndpoint(String msiEndpoint)

(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.

Parameters:

msiEndpoint - (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified. This parameter is required.

Returns:

this

resourceGroupName

@Stability(value=Experimental)
public AzurermBackend.Builder resourceGroupName(String resourceGroupName)

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

Parameters:

resourceGroupName - (Required) The Name of the Resource Group in which the Storage Account exists. This parameter is required.

Returns:

this

sasToken

@Stability(value=Experimental)
public AzurermBackend.Builder sasToken(String sasToken)

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

This can also be sourced from the ARM_SAS_TOKEN environment variable.

Parameters:

sasToken - (Optional) The SAS Token used to access the Blob Storage Account. This parameter is required.

Returns:

this

subscriptionId

@Stability(value=Experimental)
public AzurermBackend.Builder subscriptionId(String subscriptionId)

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

This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.

Parameters:

subscriptionId - (Optional) The Subscription ID in which the Storage Account exists. This parameter is required.

Returns:

this

tenantId

@Stability(value=Experimental)
public AzurermBackend.Builder tenantId(String tenantId)

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

This can also be sourced from the ARM_TENANT_ID environment variable.

Parameters:

tenantId - (Optional) The Tenant ID in which the Subscription exists. This parameter is required.

Returns:

this

useMsi

@Stability(value=Experimental)
public AzurermBackend.Builder useMsi(Boolean useMsi)

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

This can also be sourced from the ARM_USE_MSI environment variable.

Parameters:

useMsi - (Optional) Should Managed Service Identity authentication be used?. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public AzurermBackend build()

Specified by:

build in interface software.amazon.jsii.Builder<AzurermBackend>