RemoteStateS3 (Jobble Gradle Plugin Suite Combined API 0.11.3)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

org.ysb33r.gradle.terraform.remotestate.RemoteStateS3

All Implemented Interfaces and Traits:

RemoteStateS3Provider
```
@groovy.transform.CompileStatic
class RemoteStateS3
extends RemoteStateS3Spec
```
An extension that is added to TerraformRemoteStateExtension.
Authors:
Schalk W. Cronjé
Since:
0.8.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`NAME`

Inherited fields
Fields inherited from class	Fields
`class RemoteStateS3Spec`	`TOKEN_ASSUME_ROLE_POLICY, TOKEN_BUCKET, TOKEN_DYNAMODB_TABLE_ARN, TOKEN_REGION, TOKEN_REMOTE_STATE_NAME`

Constructor Summary

Constructors
Constructor and description
`RemoteStateS3 (Project project)` Constructs a description of Terraform remote state stored in S3.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static RemoteStateS3`	`findExtension(Project project)` Utility method to find this extension on a project.
	`static RemoteStateS3`	`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.
	`Provider<java.util.Map<java.lang.String, ?>>`	`getAttributesMap()` Returns a provider to a map of all S3 backend attributes that could possible be configured.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class RemoteStateS3Spec`	clear, getTokenProvider, setAccessKey, setAcl, setAssumeRoleDurationSeconds, setAssumeRolePolicy, setAssumeRolePolicy, setAssumeRolePolicyARNs, setAssumeRolePolicyARNs, setAssumeRoleTags, setAssumeRoleTransitiveTagKeys, setAssumeRoleTransitiveTagKeys, setAwsRegion, setBucket, setCredentialsFile, setDynamoDbEndpoint, setDynamoDbLockTableArn, setDynamoDbTable, setEncrypt, setExternalId, setForcePathStyle, setIamEndpoint, setMaxRetries, setProfile, setRegion, setRemoteStateName, setRoleArn, setS3BucketName, setS3Endpoint, setSecretKey, setSessionName, setSetKmsKeyId, setSkipCredentialsValidation, setSkipMetadataApiCheck, setSkipRegionValidation, setSseCustomerKey, setStsEndpoint, setWorkspaceKeyPrefix

- Field Detail
  - public static final java.lang.String NAME
- Constructor Detail
  - RemoteStateS3(Project project)
    
    Constructs a description of Terraform remote state stored in S3.
    Parameters:
    project - Project this is associated with. The object reference is not cached, so it is configuration-cache safe.
- Method Detail
  - static RemoteStateS3 findExtension(Project project)
    
    Utility method to find this extension on a project.
    Parameters:
    project - Project context
    Returns:
    Extension after it has been attached.
  - static RemoteStateS3 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.10.0
  - 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.
    Parameters:
    s3 - Another S3 state provider.
  - @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.
    Returns:
    Map provider
    Since:
    1.0

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation