Modifiers | Name | Description |
---|---|---|
static java.lang.String |
CONFIG_FILE_NAME |
Type | Name and description |
---|---|
java.lang.Object |
awsRegion |
java.lang.Object |
remoteStateName |
java.lang.Object |
s3BucketName |
Constructor and description |
---|
RemoteStateAwsS3ConfigGenerator
() |
Type Params | Return Type | Name and description |
---|---|---|
|
Provider<java.lang.String> |
getAwsRegion() Get AWS region used for remote storage. |
|
protected java.lang.String |
getConfigFileName() |
|
Provider<java.lang.String> |
getRemoteStateName() The name that will be used to identify remote state. |
|
Provider<java.lang.String> |
getS3BucketName() The S3 bucket used for state storage |
|
java.util.Map<java.lang.String, java.lang.Object> |
getTokens() Returns the current set of tokens |
|
void |
s3Spec(Action<RemoteStateS3Spec> spec) Configures a RemoteStateS3Spec. |
|
void |
s3Spec(groovy.lang.Closure spec) Configures a RemoteStateS3Spec. |
|
void |
setAwsRegion(java.lang.Object region) The AWS region used for remote state. |
|
void |
setRemoteStateName(java.lang.Object rsn) Sets a new remote state name |
|
void |
setS3BucketName(java.lang.Object bucketName) Sets the S3 bucket used for state storage. |
Methods inherited from class | Name |
---|---|
class AbstractRemoteStateConfigGenerator |
addTokenProvider, delimiterTokenPair, exec, getBackendConfigFile, getBeginToken, getConfigFileName, getDestinationDir, getEndToken, getProjectOperations, getTemplateFile, getTextTemplate, getTokens, setDestinationDir, setTemplateFile, setTextTemplate, setTokens, token, tokens |
Get AWS region used for remote storage.
The name that will be used to identify remote state.
The S3 bucket used for state storage
Returns the current set of tokens For legacy purposes the following tokens are added as aliases.
Configures a RemoteStateS3Spec.
spec
- Action to configure specConfigures a RemoteStateS3Spec.
spec
- Closure to configure spec The AWS region used for remote state.
Sets this as a token called aws_region
.
region
- Anything convertible to a string. Sets a new remote state name
Sets this as a token called remote_state_name
rsn
- Anything that can be lazy-evaluated to a string. Sets the S3 bucket used for state storage.
Sets this as a token called bucket_name
bucketName
- Bucket nameGroovy Documentation