com.hashicorp.cdktf

Class AzurermBackendProps.Builder

java.lang.Object

com.hashicorp.cdktf.AzurermBackendProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AzurermBackendProps>

Enclosing interface:

AzurermBackendProps

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

A builder for AzurermBackendProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AzurermBackendProps.Builder	accessKey(String accessKey) Sets the value of AzurermBackendProps.getAccessKey()
AzurermBackendProps	build() Builds the configured instance.
AzurermBackendProps.Builder	clientId(String clientId) Sets the value of AzurermBackendProps.getClientId()
AzurermBackendProps.Builder	clientSecret(String clientSecret) Sets the value of AzurermBackendProps.getClientSecret()
AzurermBackendProps.Builder	containerName(String containerName) Sets the value of AzurermBackendProps.getContainerName()
AzurermBackendProps.Builder	endpoint(String endpoint) Sets the value of AzurermBackendProps.getEndpoint()
AzurermBackendProps.Builder	environment(String environment) Sets the value of AzurermBackendProps.getEnvironment()
AzurermBackendProps.Builder	key(String key) Sets the value of AzurermBackendProps.getKey()
AzurermBackendProps.Builder	msiEndpoint(String msiEndpoint) Sets the value of AzurermBackendProps.getMsiEndpoint()
AzurermBackendProps.Builder	resourceGroupName(String resourceGroupName) Sets the value of AzurermBackendProps.getResourceGroupName()
AzurermBackendProps.Builder	sasToken(String sasToken) Sets the value of AzurermBackendProps.getSasToken()
AzurermBackendProps.Builder	storageAccountName(String storageAccountName) Sets the value of AzurermBackendProps.getStorageAccountName()
AzurermBackendProps.Builder	subscriptionId(String subscriptionId) Sets the value of AzurermBackendProps.getSubscriptionId()
AzurermBackendProps.Builder	tenantId(String tenantId) Sets the value of AzurermBackendProps.getTenantId()
AzurermBackendProps.Builder	useMsi(Boolean useMsi) Sets the value of AzurermBackendProps.getUseMsi()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

containerName

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

Sets the value of AzurermBackendProps.getContainerName()

Parameters:

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

Returns:

this

key

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

Sets the value of AzurermBackendProps.getKey()

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 AzurermBackendProps.Builder storageAccountName(String storageAccountName)

Sets the value of AzurermBackendProps.getStorageAccountName()

Parameters:

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

Returns:

this

accessKey

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

Sets the value of AzurermBackendProps.getAccessKey()

Parameters:

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

Returns:

this

clientId

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

Sets the value of AzurermBackendProps.getClientId()

Parameters:

clientId - (Optional) The Client ID of the Service Principal. This can also be sourced from the ARM_CLIENT_ID environment variable.

Returns:

this

clientSecret

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

Sets the value of AzurermBackendProps.getClientSecret()

Parameters:

clientSecret - (Optional) The Client Secret of the Service Principal. This can also be sourced from the ARM_CLIENT_SECRET environment variable.

Returns:

this

endpoint

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

Sets the value of AzurermBackendProps.getEndpoint()

Parameters:

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

Returns:

this

environment

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

Sets the value of AzurermBackendProps.getEnvironment()

Parameters:

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

Returns:

this

msiEndpoint

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

Sets the value of AzurermBackendProps.getMsiEndpoint()

Parameters:

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

Returns:

this

resourceGroupName

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

Sets the value of AzurermBackendProps.getResourceGroupName()

Parameters:

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

Returns:

this

sasToken

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

Sets the value of AzurermBackendProps.getSasToken()

Parameters:

sasToken - (Optional) The SAS Token used to access the Blob Storage Account. This can also be sourced from the ARM_SAS_TOKEN environment variable.

Returns:

this

subscriptionId

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

Sets the value of AzurermBackendProps.getSubscriptionId()

Parameters:

subscriptionId - (Optional) The Subscription ID in which the Storage Account exists. This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.

Returns:

this

tenantId

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

Sets the value of AzurermBackendProps.getTenantId()

Parameters:

tenantId - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the ARM_TENANT_ID environment variable.

Returns:

this

useMsi

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

Sets the value of AzurermBackendProps.getUseMsi()

Parameters:

useMsi - (Optional) Should Managed Service Identity authentication be used?. This can also be sourced from the ARM_USE_MSI environment variable.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AzurermBackendProps

Throws:

NullPointerException - if any required attribute was not provided