Property Detail

• java.lang.Object awsRegion

• java.lang.Object destinationDir

• java.lang.Object remoteStateName

• java.lang.Object s3BucketName

• java.lang.Object templateFile

• java.lang.Object textTemplate

• java.util.Map<java.lang.String, java.lang.Object> tokens

Constructor Detail

• @java.lang.SuppressWarnings('UnnecessaryCast') @Inject RemoteStateAwsS3ConfigGenerator(TaskProvider<RemoteStateConfigGenerator> linkedTask)

Method Detail

• @java.lang.SuppressWarnings('UnusedMethodParameter') void addTokenProvider(Provider<java.util.Map<java.lang.String, java.lang.Object>> tokenProvider)

• void delimiterTokenPair(java.lang.String begin, java.lang.String end)

• @Internal @java.lang.Deprecated Provider<java.lang.String> getAwsRegion()

  Get AWS region used for remote storage.

  deprecated:

  Returns:

  Region*

• @Internal Provider<java.io.File> getBackendConfigFile()

• @Internal java.lang.String getBeginToken()

• @Internal Provider<java.io.File> getDestinationDir()

• @Internal java.lang.String getEndToken()

• @Internal @java.lang.Deprecated Provider<java.lang.String> getRemoteStateName()

  The name that will be used to identify remote state.

  deprecated:

  Returns:

  Remote state name

• @Internal @java.lang.Deprecated Provider<java.lang.String> getS3BucketName()

  The S3 bucket used for state storage

  deprecated:

  Returns:

  Bucket name provider

• @Internal Provider<java.io.File> getTemplateFile()

• @Internal Provider<java.lang.String> getTextTemplate()

• @java.lang.Deprecated @Internal java.util.Map<java.lang.String, java.lang.Object> getTokens()

  Returns the current set of tokens For legacy purposes the following tokens are added as aliases.

  • name as alias for remote_state_name.
  • aws_bucket as alias for bucket.
  • aws_region as alias for region.

  Returns:

  Tokens used for replacements.

• @java.lang.Deprecated void s3Spec(Action<RemoteStateS3Spec> spec)

  Configures a RemoteStateS3Spec.

  Parameters:

  spec - Action to configure spec

• @java.lang.Deprecated @java.lang.SuppressWarnings('DuplicateStringLiteral') void s3Spec(@groovy.lang.DelegatesTo(RemoteStateS3Spec) groovy.lang.Closure spec)

  Configures a RemoteStateS3Spec.

  Parameters:

  spec - Closure to configure spec

• @java.lang.Deprecated void setAwsRegion(java.lang.Object region)

  The AWS region used for remote state. Sets this as a token called aws_region.

  deprecated:

  Configure via s3Spec instead

  Parameters:

  region - Anything convertible to a string.

• @java.lang.SuppressWarnings('UnusedMethodParameter') void setDestinationDir(java.lang.Object dir)

• @java.lang.Deprecated void setRemoteStateName(java.lang.Object rsn)

  Sets a new remote state name Sets this as a token called remote_state_name

  Parameters:

  rsn - Anything that can be lazy-evaluated to a string.

• @java.lang.Deprecated void setS3BucketName(java.lang.Object bucketName)

  Sets the S3 bucket used for state storage. Sets this as a token called bucket_name

  deprecated:

  Configure via s3Spec instead.

  Parameters:

  bucketName - Bucket name

• void setTemplateFile(java.lang.Object file)

• void setTextTemplate(java.lang.Object text)

• void setTokens(java.util.Map<java.lang.String, java.lang.Object> newTokens)

• void token(java.lang.String key, java.lang.Object value)

• void tokens(java.util.Map<java.lang.String, java.lang.Object> moreTokens)