RemoteStateS3Spec (Jobble Gradle Plugin Suite Combined API 0.14.1)

org.ysb33r.gradle.terraform.remotestate.RemoteStateS3Spec

All Implemented Interfaces and Traits:: RemoteStateS3Provider

@groovy.transform.CompileStatic
@java.lang.SuppressWarnings('MethodCount')
@groovy.util.logging.Slf4j
class RemoteStateS3Spec
extends AbstractBackendSpec

Describes the attributed for a remote S3 backend.

Authors:: Schalk W. Cronjé

Since:: 0.10

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`NAME`
`static java.lang.String`	`TOKEN_ASSUME_ROLE_POLICY`
`static java.lang.String`	`TOKEN_BUCKET`
`static java.lang.String`	`TOKEN_DYNAMODB_TABLE_ARN`
`static java.lang.String`	`TOKEN_REGION`
`static java.lang.String`	`TOKEN_REMOTE_STATE_NAME`

Inherited fields
Fields inherited from class	Fields
`class AbstractBackendSpec`	`DEFAULT_TOKEN_DELIMITER`

Properties Summary

Properties
Type	Name and description
`TerraformRemoteStateExtension`	`associatedRemoteStateExtension`
`java.lang.String`	`defaultTextTemplate`
`java.lang.String`	`name` Name of backend.

Constructor Summary

Constructors
Constructor and description
`RemoteStateS3Spec (ProjectOperations po, ObjectFactory objects)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static RemoteStateS3Spec`	`findExtension(Project project)` Utility method to find this extension on a project.
	`static RemoteStateS3Spec`	`findExtension(Project project, java.lang.String sourceSetName)` Utility to find this extension on a terraform source set.
	`void`	`follow(RemoteStateS3Provider s3)` Make settings follow that of another `RemoteStateS3` provider.
	`TerraformRemoteStateExtension`	`getAssociatedRemoteStateExtension()`
	`Provider<java.util.Map<java.lang.String, ?>>`	`getAttributesMap()` Returns a provider to a map of all S3 backend attributes that could possible be configured.
	`void`	`setAccessKey(java.lang.Object value)` Sets a token called `access_key`.
	`void`	`setAcl(java.lang.Object value)` Sets a token called `acl`.
	`void`	`setAssociatedRemoteStateExtension(TerraformRemoteStateExtension trse)`
	`void`	`setAssumeRoleDurationSeconds(java.lang.Integer value)` Sets a token called `assume_role_duration_seconds`.
	`void`	`setAssumeRolePolicy(java.util.Map<java.lang.String, ?> policy)` Sets a token called `assume_role_policy`.
	`void`	`setAssumeRolePolicy(java.lang.String policy)` Sets a token called `assume_role_policy`.
	`void`	`setAssumeRolePolicyARNs(java.lang.Iterable<java.lang.Object> items)` Sets a token called `assume_role_policy_arns`.
	`void`	`setAssumeRolePolicyARNs(java.lang.Object... items)` Sets a token called `assume_role_policy_arns`.
	`void`	`setAssumeRoleTags(java.util.Map<java.lang.String, java.lang.Object> items)` Sets a token called `assume_role_tags`.
	`void`	`setAssumeRoleTransitiveTagKeys(java.lang.Iterable<java.lang.Object> items)` Sets a token called `assume_role_transitive_tag_keys`.
	`void`	`setAssumeRoleTransitiveTagKeys(java.lang.Object... items)` Sets a token called `assume_role_transitive_tag_keys`.
	`void`	`setAwsRegion(java.lang.Object region)` The AWS region used for remote state.
	`void`	`setBucket(java.lang.Object bucketName)` Alias for setS3BucketName
	`void`	`setCredentialsFile(java.lang.Object value)` Sets a token called `shared_credentials_file`.
	`void`	`setDynamoDbEndpoint(java.lang.Object value)` Sets a token called `dynamodb_endpoint`.
	`void`	`setDynamoDbLockTableArn(java.lang.Object value)` Sets a token called `aws_dynamodb_lock_table_arn`.
	`void`	`setDynamoDbTable(java.lang.Object value)` Sets a token called `dynamodb_table_arn`.
	`void`	`setEncrypt(java.lang.Boolean value)` Sets a token called `encrypt`.
	`void`	`setExternalId(java.lang.Object value)` Sets a token called `external_id`.
	`void`	`setForcePathStyle(java.lang.Boolean value)` Sets a token called `force_path_style`.
	`void`	`setIamEndpoint(java.lang.Object value)` Sets a token called `iam_endpoint`.
	`void`	`setKey(java.lang.Object rsn)` Sets a new remote state name
	`void`	`setMaxRetries(java.lang.Integer value)` Sets a token called `iam_endpoint`.
	`void`	`setProfile(java.lang.Object value)` Sets a token called `profile`.
	`void`	`setRegion(java.lang.Object region)` Alias for setAwsRegion.
	`void`	`setRemoteStateName(java.lang.Object rsn)` Sets a new remote state name
	`void`	`setRoleArn(java.lang.Object value)` Sets a token called `role_arn`.
	`void`	`setS3BucketName(java.lang.Object bucketName)` Sets the S3 bucket used for state storage.
	`void`	`setS3Endpoint(java.lang.Object value)` Sets a token called `endpoint`.
	`void`	`setSecretKey(java.lang.Object value)` Sets a token called `secret_key`.
	`void`	`setSessionName(java.lang.Object value)` Sets a token called `session_name`.
	`void`	`setSetKmsKeyId(java.lang.Object value)` Sets a token called `kms_key_id`.
	`void`	`setSkipCredentialsValidation(java.lang.Boolean value)` Sets a token called `skip_credentials_validation`.
	`void`	`setSkipMetadataApiCheck(java.lang.Boolean value)` Sets a token called `skip_metadata_api_check`.
	`void`	`setSkipRegionValidation(java.lang.Boolean value)` Sets a token called `skip_region_validation`.
	`void`	`setSseCustomerKey(java.lang.Object value)` Sets a token called `sse_customer_key`.
	`void`	`setStsEndpoint(java.lang.Object value)` Sets a token called `sts_endpoint`.
	`void`	`setWorkspaceKeyPrefix(java.lang.Object value)` Sets a token called `workspace_key_prefix`.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractBackendSpec`	`addTokenProvider, allTokenTemplate, clear, configure, configure, delimiterTokenPair, findExtension, findExtension, getBeginTokenProvider, getEndTokenProvider, getProjectOperations, getTemplateFile, getTextTemplate, getTokenProvider, getTokens, setTemplateFile, setTextTemplate, setTokens, token, tokenPath, tokens`

- Field Detail
  - public static final java.lang.String NAME
  - public static final java.lang.String TOKEN_ASSUME_ROLE_POLICY
  - public static final java.lang.String TOKEN_BUCKET
  - @java.lang.Deprecated public static final java.lang.String TOKEN_DYNAMODB_TABLE_ARN
  - public static final java.lang.String TOKEN_REGION
  - public static final java.lang.String TOKEN_REMOTE_STATE_NAME
- Property Detail
  - TerraformRemoteStateExtension associatedRemoteStateExtension
  - final java.lang.String defaultTextTemplate
  - final java.lang.String name
    
    Name of backend.
    Returns:
    Name of backend.
    Since:
    0.12
- Constructor Detail
  - RemoteStateS3Spec(ProjectOperations po, ObjectFactory objects)
- Method Detail
  - static RemoteStateS3Spec findExtension(Project project)
    
    Utility method to find this extension on a project.
    Parameters:
    project - Project context
    Returns:
    Extension after it has been attached.
    Since:
    0.12
  - static RemoteStateS3Spec findExtension(Project project, java.lang.String sourceSetName)
    
    Utility to find this extension on a terraform source set.
    Parameters:
    project - Project context
    sourceSetName - Name of source set.
    Returns:
    Extension after it has been attached.
    Since:
    0.12
  - @java.lang.Deprecated @java.lang.SuppressWarnings('LineLength') void follow(RemoteStateS3Provider s3)
    
    Make settings follow that of another RemoteStateS3 provider. Following a provider will apply those items first and then customise with any local settings.
    deprecated:
    Do not use this at all. Use TerraformRemoteStateExtension.follow instead.
    
    Parameters:
    s3 - Another S3 state provider.
  - @java.lang.Override @java.lang.Deprecated TerraformRemoteStateExtension getAssociatedRemoteStateExtension()
  - @java.lang.Deprecated @java.lang.Override Provider<java.util.Map<java.lang.String, ?>> getAttributesMap()
    
    Returns a provider to a map of all S3 backend attributes that could possible be configured.
    deprecated:
    
    Returns:
    Map provider
  - void setAccessKey(java.lang.Object value)
    
    Sets a token called access_key.
    Parameters:
    value - AWS access key
  - void setAcl(java.lang.Object value)
    
    Sets a token called acl.
    Parameters:
    value - Canned S3 ACL to be applied to state file.
    See Also:
    https
  - @java.lang.Deprecated @java.lang.Override void setAssociatedRemoteStateExtension(TerraformRemoteStateExtension trse)
  - void setAssumeRoleDurationSeconds(java.lang.Integer value)
    
    Sets a token called assume_role_duration_seconds.
    Parameters:
    value - Number of seconds
  - void setAssumeRolePolicy(java.util.Map<java.lang.String, ?> policy)
    
    Sets a token called assume_role_policy.
    Parameters:
    value - Policy in the form of a map.
  - void setAssumeRolePolicy(java.lang.String policy)
    
    Sets a token called assume_role_policy.
    Parameters:
    value - Policy as a JSON string.
  - void setAssumeRolePolicyARNs(java.lang.Iterable<java.lang.Object> items)
    
    Sets a token called assume_role_policy_arns.
    Parameters:
    value - ARNs.
  - void setAssumeRolePolicyARNs(java.lang.Object... items)
    
    Sets a token called assume_role_policy_arns.
    Parameters:
    value - ARNs.
  - void setAssumeRoleTags(java.util.Map<java.lang.String, java.lang.Object> items)
    
    Sets a token called assume_role_tags.
    Parameters:
    value - Tags.
  - void setAssumeRoleTransitiveTagKeys(java.lang.Iterable<java.lang.Object> items)
    
    Sets a token called assume_role_transitive_tag_keys.
    Parameters:
    value - Tag keys.
  - void setAssumeRoleTransitiveTagKeys(java.lang.Object... items)
    
    Sets a token called assume_role_transitive_tag_keys.
    Parameters:
    value - Tag keys.
  - void setAwsRegion(java.lang.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(java.lang.Object bucketName)
    
    Alias for setS3BucketName
    Parameters:
    bucketName - Bucket name
  - void setCredentialsFile(java.lang.Object value)
    
    Sets a token called shared_credentials_file.
    Parameters:
    value - AWS shared credentials file. Anything convertible to a file
  - void setDynamoDbEndpoint(java.lang.Object value)
    
    Sets a token called dynamodb_endpoint.
    Parameters:
    value - Custom DynamoDB endpoint.
  - @java.lang.Deprecated void setDynamoDbLockTableArn(java.lang.Object value)
    
    Sets a token called aws_dynamodb_lock_table_arn.
    deprecated:
    Use setDynamoDbTable instead.
    
    Parameters:
    value - Full ARN to DynamoDB lock tabke.
  - void setDynamoDbTable(java.lang.Object value)
    
    Sets a token called dynamodb_table_arn.
    Parameters:
    value - Full ARN to DynamoDB lock tabke.
  - void setEncrypt(java.lang.Boolean value)
    
    Sets a token called encrypt.
    Parameters:
    value - Enable server-side encryption of state file.
  - void setExternalId(java.lang.Object value)
    
    Sets a token called external_id.
    Parameters:
    value - AWS external id for assumed role.
  - void setForcePathStyle(java.lang.Boolean value)
    
    Sets a token called force_path_style.
    Parameters:
    value - true to force https://<HOST>/<BUCKET>.
  - void setIamEndpoint(java.lang.Object value)
    
    Sets a token called iam_endpoint.
    Parameters:
    value - Customised IAM endpoint
  - void setKey(java.lang.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(java.lang.Integer value)
    
    Sets a token called iam_endpoint.
    Parameters:
    value - Max retries.
  - void setProfile(java.lang.Object value)
    
    Sets a token called profile.
    Parameters:
    value - AWS credentials profile
  - void setRegion(java.lang.Object region)
    
    Alias for setAwsRegion.
    Parameters:
    region - Anything convertible to a string.
  - void setRemoteStateName(java.lang.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 setRoleArn(java.lang.Object value)
    
    Sets a token called role_arn.
    Parameters:
    value - AWS ARN for assumed role.
  - void setS3BucketName(java.lang.Object bucketName)
    
    Sets the S3 bucket used for state storage. Sets this as a token called bucket_name
    Parameters:
    bucketName - Bucket name
  - void setS3Endpoint(java.lang.Object value)
    
    Sets a token called endpoint.
    Parameters:
    value - Custom S3 endpoint.
  - void setSecretKey(java.lang.Object value)
    
    Sets a token called secret_key.
    Parameters:
    value - AWS secret
  - void setSessionName(java.lang.Object value)
    
    Sets a token called session_name.
    Parameters:
    value - AWS ARN for assumed role.
  - void setSetKmsKeyId(java.lang.Object value)
    
    Sets a token called kms_key_id.
    Parameters:
    value - Key identifier.
  - void setSkipCredentialsValidation(java.lang.Boolean value)
    
    Sets a token called skip_credentials_validation.
    Parameters:
    value - true to skip credentials validation
  - void setSkipMetadataApiCheck(java.lang.Boolean value)
    
    Sets a token called skip_metadata_api_check.
    Parameters:
    value - true to skip metadata API check.
  - void setSkipRegionValidation(java.lang.Boolean value)
    
    Sets a token called skip_region_validation.
    Parameters:
    value - true to skip region validation
  - void setSseCustomerKey(java.lang.Object value)
    
    Sets a token called sse_customer_key.
    Parameters:
    value - SSE customer key.
  - void setStsEndpoint(java.lang.Object value)
    
    Sets a token called sts_endpoint.
    Parameters:
    value - Customised STS endpoint
  - void setWorkspaceKeyPrefix(java.lang.Object value)
    
    Sets a token called workspace_key_prefix.
    Parameters:
    value - Workspace key prefix for non-default workspace.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class RemoteStateS3Spec

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String NAME

public static final java.lang.String TOKEN_ASSUME_ROLE_POLICY

public static final java.lang.String TOKEN_BUCKET

@java.lang.Deprecated public static final java.lang.String TOKEN_DYNAMODB_TABLE_ARN

public static final java.lang.String TOKEN_REGION

public static final java.lang.String TOKEN_REMOTE_STATE_NAME

Property Detail

TerraformRemoteStateExtension associatedRemoteStateExtension

final java.lang.String defaultTextTemplate

final java.lang.String name

Constructor Detail

RemoteStateS3Spec(ProjectOperations po, ObjectFactory objects)

Method Detail

static RemoteStateS3Spec findExtension(Project project)

static RemoteStateS3Spec findExtension(Project project, java.lang.String sourceSetName)

@java.lang.Deprecated @java.lang.SuppressWarnings('LineLength') void follow(RemoteStateS3Provider s3)

@java.lang.Override @java.lang.Deprecated TerraformRemoteStateExtension getAssociatedRemoteStateExtension()

@java.lang.Deprecated @java.lang.Override Provider<java.util.Map<java.lang.String, ?>> getAttributesMap()

void setAccessKey(java.lang.Object value)

void setAcl(java.lang.Object value)

@java.lang.Deprecated @java.lang.Override void setAssociatedRemoteStateExtension(TerraformRemoteStateExtension trse)

void setAssumeRoleDurationSeconds(java.lang.Integer value)

void setAssumeRolePolicy(java.util.Map<java.lang.String, ?> policy)

void setAssumeRolePolicy(java.lang.String policy)

void setAssumeRolePolicyARNs(java.lang.Iterable<java.lang.Object> items)

void setAssumeRolePolicyARNs(java.lang.Object... items)

void setAssumeRoleTags(java.util.Map<java.lang.String, java.lang.Object> items)

void setAssumeRoleTransitiveTagKeys(java.lang.Iterable<java.lang.Object> items)

void setAssumeRoleTransitiveTagKeys(java.lang.Object... items)

void setAwsRegion(java.lang.Object region)

void setBucket(java.lang.Object bucketName)

void setCredentialsFile(java.lang.Object value)

void setDynamoDbEndpoint(java.lang.Object value)

@java.lang.Deprecated void setDynamoDbLockTableArn(java.lang.Object value)

void setDynamoDbTable(java.lang.Object value)

void setEncrypt(java.lang.Boolean value)

void setExternalId(java.lang.Object value)

void setForcePathStyle(java.lang.Boolean value)

void setIamEndpoint(java.lang.Object value)

void setKey(java.lang.Object rsn)

void setMaxRetries(java.lang.Integer value)

void setProfile(java.lang.Object value)

void setRegion(java.lang.Object region)

void setRemoteStateName(java.lang.Object rsn)

void setRoleArn(java.lang.Object value)

void setS3BucketName(java.lang.Object bucketName)

void setS3Endpoint(java.lang.Object value)

void setSecretKey(java.lang.Object value)

void setSessionName(java.lang.Object value)

void setSetKmsKeyId(java.lang.Object value)

void setSkipCredentialsValidation(java.lang.Boolean value)

void setSkipMetadataApiCheck(java.lang.Boolean value)

void setSkipRegionValidation(java.lang.Boolean value)

void setSseCustomerKey(java.lang.Object value)

void setStsEndpoint(java.lang.Object value)

void setWorkspaceKeyPrefix(java.lang.Object value)