S3Backend (opentofu-base-plugin 2.5.1 API)

org.ysb33r.gradle.opentofu.backends.S3Backend

@groovy.transform.CompileStatic
@SuppressWarnings(value: MethodCount)
@groovy.util.logging.Slf4j
class S3Backend
extends OpenTofuBackend

Describes the attributed for a remote S3 backend.

Authors:: Schalk W. Cronjé

Since:: 0.10

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`S3Backend.AssumeRole`	Base class for configuring assume roles without web identity.
`static class`	`S3Backend.AssumeRoleBase`	Base class for configuring assume roles with or without web identity.
`static class`	`S3Backend.WebIdentity`

Field Summary

Fields
Modifiers	Name	Description
`static String`	`AWS_ACCESS_KEY`
`static String`	`AWS_SECRET_KEY`
`static String`	`TOKEN_ASSUME_ROLE`
`static String`	`TOKEN_ASSUME_ROLE_POLICY`
`static String`	`TOKEN_BUCKET`
`static String`	`TOKEN_ENDPOINTS`
`static String`	`TOKEN_REGION`
`static String`	`TOKEN_REMOTE_STATE_NAME`
`static String`	`TOKEN_TRANSITIVE_TAG_KEYS`
`static String`	`TOKEN_WEB_IDENTITY`

Inherited fields
Fields inherited from class	Fields
`class OpenTofuBackend`	`parent`

Constructor Summary

Constructors
Constructor and description
`S3Backend (String name, OpenTofuExtension parent, Project tempProjectRef)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`S3Backend.AssumeRole`	`assumeRole(Action<AssumeRole> configurator)` Configures backend assume role.
	`S3Backend.AssumeRole`	`assumeRole(groovy.lang.Closure<?> configurator)` Configures backend assume role.
	`java.util.Map<String, TokenValue>`	`customSourceSetTokens(SourceSetBase sourceSet)` Generates tokens for a specific source set & backend combination.
	`void`	`setAccessKey(Object value)` Sets a token called `access_key`.
	`void`	`setAccessKeyProperty(String propertyName)` Sets a token called `access_key`.
	`void`	`setAcl(Object value)` Sets a token called `acl`.
	`void`	`setAwsRegion(Object region)` The AWS region used for remote state.
	`void`	`setBucket(Object bucketName)` Alias for setS3BucketName
	`void`	`setCredentialsFile(Object value)` Sets a token called `shared_credentials_file`.
	`void`	`setDynamoDbEndpoint(Object value)` Sets a token called `endpoints.dynamodb`.
	`void`	`setDynamoDbTable(Object value)` Sets a token called `dynamodb_table_arn`.
	`void`	`setEncrypt(Boolean value)` Sets a token called `encrypt`.
	`void`	`setForcePathStyle(Boolean value)` Sets a token called `force_path_style`.
	`void`	`setIamEndpoint(Object value)` Sets a token called `endpoints.iam`.
	`void`	`setKey(Object rsn)` Sets a new remote state name
	`void`	`setMaxRetries(Integer value)` Sets a token called `iam_endpoint`.
	`void`	`setProfile(Object value)` Sets a token called `profile`.
	`void`	`setRegion(Object region)` Alias for setAwsRegion.
	`void`	`setRemoteStateName(Object rsn)` Sets a new remote state name
	`void`	`setS3BucketName(Object bucketName)` Sets the S3 bucket used for state storage.
	`void`	`setS3Endpoint(Object value)` Sets a token called `endpoints.s3`.
	`void`	`setSecretKey(Object value)` Sets a token called `secret_key`.
	`void`	`setSecretProperty(String propertyName)` Sets a token called `secret_key`.
	`void`	`setSetKmsKeyId(Object value)` Sets a token called `kms_key_id`.
	`void`	`setSkipCredentialsValidation(Boolean value)` Sets a token called `skip_credentials_validation`.
	`void`	`setSkipMetadataApiCheck(Boolean value)` Sets a token called `skip_metadata_api_check`.
	`void`	`setSkipRegionValidation(Boolean value)` Sets a token called `skip_region_validation`.
	`void`	`setSseCustomerKey(Object value)` Sets a token called `sse_customer_key`.
	`void`	`setStsEndpoint(Object value)` Sets a token called `endpoints.endpoints.`.
	`void`	`setWorkspaceKeyPrefix(Object value)` Sets a token called `workspace_key_prefix`.

- Field Detail
  - public static final String AWS_ACCESS_KEY
  - public static final String AWS_SECRET_KEY
  - public static final String TOKEN_ASSUME_ROLE
  - public static final String TOKEN_ASSUME_ROLE_POLICY
  - public static final String TOKEN_BUCKET
  - public static final String TOKEN_ENDPOINTS
  - public static final String TOKEN_REGION
  - public static final String TOKEN_REMOTE_STATE_NAME
  - public static final String TOKEN_TRANSITIVE_TAG_KEYS
  - public static final String TOKEN_WEB_IDENTITY
- Constructor Detail
  - @javax.inject.Inject S3Backend(String name, OpenTofuExtension parent, Project tempProjectRef)
- Method Detail
  - S3Backend.AssumeRole assumeRole(Action<AssumeRole> configurator)
    
    Configures backend assume role.
    Parameters:
    configurator - Configurator
    Returns:
    Reference to assume role configuration.
    Since:
    2.0
  - S3Backend.AssumeRole assumeRole(@groovy.lang.DelegatesTo(value: AssumeRole) groovy.lang.Closure<?> configurator)
    
    Configures backend assume role.
    Parameters:
    configurator - Configurator
    Returns:
    Reference to assume role configuration.
  - @Override java.util.Map<String, TokenValue> customSourceSetTokens(SourceSetBase sourceSet)
    
    Generates tokens for a specific source set & backend combination. Default does not configure anything.
    Parameters:
    sourceSet - source set used as input for configuration.
  - void setAccessKey(Object value)
    
    Sets a token called access_key.
    Parameters:
    value - AWS access key
  - void setAccessKeyProperty(String propertyName)
    
    Sets a token called access_key.
    Parameters:
    propertyName - Name of Gradle/system property holding AWS access key. (Will fallback to environment variable).
  - void setAcl(Object value)
    
    Sets a token called acl.
    Parameters:
    value - Canned S3 ACL to be applied to state file.
    See Also:
    ACL Overview
  - void setAwsRegion(Object region)
    
    The AWS region used for remote state. Sets this as a token called aws_region.
    Parameters:
    region - Anything convertible to a string.
  - void setBucket(Object bucketName)
    
    Alias for setS3BucketName
    Parameters:
    bucketName - Bucket name
  - void setCredentialsFile(Object value)
    
    Sets a token called shared_credentials_file.
    Parameters:
    value - AWS shared credentials file. Anything convertible to a file
  - void setDynamoDbEndpoint(Object value)
    
    Sets a token called endpoints.dynamodb.
    Parameters:
    value - Custom DynamoDB endpoint.
  - void setDynamoDbTable(Object value)
    
    Sets a token called dynamodb_table_arn.
    Parameters:
    value - Full ARN to DynamoDB lock tabke.
  - void setEncrypt(Boolean value)
    
    Sets a token called encrypt.
    Parameters:
    value - Enable server-side encryption of state file.
  - void setForcePathStyle(Boolean value)
    
    Sets a token called force_path_style.
    Parameters:
    value - true to force https://<HOST>/<BUCKET>.
  - void setIamEndpoint(Object value)
    
    Sets a token called endpoints.iam.
    Parameters:
    value - Customised IAM endpoint
  - void setKey(Object rsn)
    
    Sets a new remote state name Sets this as a token called key Alternative to setRemoteStateName.
    Parameters:
    rsn - Anything that can be lazy-evaluated to a string.
    Since:
    0.12
  - void setMaxRetries(Integer value)
    
    Sets a token called iam_endpoint.
    Parameters:
    value - Max retries.
  - void setProfile(Object value)
    
    Sets a token called profile.
    Parameters:
    value - AWS credentials profile
  - void setRegion(Object region)
    
    Alias for setAwsRegion.
    Parameters:
    region - Anything convertible to a string.
  - void setRemoteStateName(Object rsn)
    
    Sets a new remote state name Sets this as a token called key
    Parameters:
    rsn - Anything that can be lazy-evaluated to a string.
  - void setS3BucketName(Object bucketName)
    
    Sets the S3 bucket used for state storage. Sets this as a token called bucket_name
    Parameters:
    bucketName - Bucket name
  - void setS3Endpoint(Object value)
    
    Sets a token called endpoints.s3.
    Parameters:
    value - Custom S3 endpoint.
  - void setSecretKey(Object value)
    
    Sets a token called secret_key.
    Parameters:
    value - AWS secret
  - void setSecretProperty(String propertyName)
    
    Sets a token called secret_key.
    Parameters:
    propertyName - Name of property holding the secret.
  - void setSetKmsKeyId(Object value)
    
    Sets a token called kms_key_id.
    Parameters:
    value - Key identifier.
  - void setSkipCredentialsValidation(Boolean value)
    
    Sets a token called skip_credentials_validation.
    Parameters:
    value - true to skip credentials validation
  - void setSkipMetadataApiCheck(Boolean value)
    
    Sets a token called skip_metadata_api_check.
    Parameters:
    value - true to skip metadata API check.
  - void setSkipRegionValidation(Boolean value)
    
    Sets a token called skip_region_validation.
    Parameters:
    value - true to skip region validation
  - void setSseCustomerKey(Object value)
    
    Sets a token called sse_customer_key.
    Parameters:
    value - SSE customer key.
  - void setStsEndpoint(Object value)
    
    Sets a token called endpoints.endpoints..
    Parameters:
    value - Customised STS endpoint
  - void setWorkspaceKeyPrefix(Object value)
    
    Sets a token called workspace_key_prefix.
    Parameters:
    value - Workspace key prefix for non-default workspace.

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class S3Backend

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Field Detail

public static final String AWS_ACCESS_KEY

public static final String AWS_SECRET_KEY

public static final String TOKEN_ASSUME_ROLE

public static final String TOKEN_ASSUME_ROLE_POLICY

public static final String TOKEN_BUCKET

public static final String TOKEN_ENDPOINTS

public static final String TOKEN_REGION

public static final String TOKEN_REMOTE_STATE_NAME

public static final String TOKEN_TRANSITIVE_TAG_KEYS

public static final String TOKEN_WEB_IDENTITY

Constructor Detail

@javax.inject.Inject S3Backend(String name, OpenTofuExtension parent, Project tempProjectRef)

Method Detail

S3Backend.AssumeRole assumeRole(Action<AssumeRole> configurator)

S3Backend.AssumeRole assumeRole(@groovy.lang.DelegatesTo(value: AssumeRole) groovy.lang.Closure<?> configurator)

@Override java.util.Map<String, TokenValue> customSourceSetTokens(SourceSetBase sourceSet)

void setAccessKey(Object value)

void setAccessKeyProperty(String propertyName)

void setAcl(Object value)

void setAwsRegion(Object region)

void setBucket(Object bucketName)

void setCredentialsFile(Object value)

void setDynamoDbEndpoint(Object value)

void setDynamoDbTable(Object value)

void setEncrypt(Boolean value)

void setForcePathStyle(Boolean value)

void setIamEndpoint(Object value)

void setKey(Object rsn)

void setMaxRetries(Integer value)

void setProfile(Object value)

void setRegion(Object region)

void setRemoteStateName(Object rsn)

void setS3BucketName(Object bucketName)

void setS3Endpoint(Object value)

void setSecretKey(Object value)

void setSecretProperty(String propertyName)

void setSetKmsKeyId(Object value)

void setSkipCredentialsValidation(Boolean value)

void setSkipMetadataApiCheck(Boolean value)

void setSkipRegionValidation(Boolean value)

void setSseCustomerKey(Object value)

void setStsEndpoint(Object value)

void setWorkspaceKeyPrefix(Object value)