Module org.github.gestalt.aws
Package org.github.gestalt.config.aws.s3

Class S3ConfigSourceBuilder

  • public final class S3ConfigSourceBuilder
extends org.github.gestalt.config.builder.SourceBuilder<S3ConfigSourceBuilder,​S3ConfigSource>
    ConfigSourceBuilder for the S3 Config Source.

    Create a S3ConfigSource to load a config from S3.

    • Field Summary

      • Fields inherited from class org.github.gestalt.config.builder.SourceBuilder

        configReloadStrategies, source, tags

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.github.gestalt.config.source.ConfigSourcePackage build()  
      static S3ConfigSourceBuilder builder()
      Static function to create the builder.
      java.lang.String getBucketName()
      Get the s3 bucket name.
      java.lang.String getKeyName()
      Get the s3 key name.
      software.amazon.awssdk.services.s3.S3Client getS3()
      Get the S3 client.
      S3ConfigSourceBuilder setBucketName​(java.lang.String bucketName)
      Set the s3 bucket name.
      S3ConfigSourceBuilder setKeyName​(java.lang.String keyName)
      Set the s3 key name.
      S3ConfigSourceBuilder setS3​(software.amazon.awssdk.services.s3.S3Client s3)
      Set the S3 client.

      • Methods inherited from class org.github.gestalt.config.builder.SourceBuilder

        addConfigReloadStrategy, addTag, addTags, buildPackage, getConfigReloadStrategies, getTags, self, setTags

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • builder

        public static S3ConfigSourceBuilder builder()
        Static function to create the builder.
        Returns:
        the builder

      • getS3

        public software.amazon.awssdk.services.s3.S3Client getS3()
        Get the S3 client.
        Returns:
        the S3 client

      • setS3

        public S3ConfigSourceBuilder setS3​(software.amazon.awssdk.services.s3.S3Client s3)
        Set the S3 client.
        Parameters:
        s3 - the S3 client
        Returns:
        builder

      • getKeyName

        public java.lang.String getKeyName()
        Get the s3 key name.
        Returns:
        the s3 key name

      • setKeyName

        public S3ConfigSourceBuilder setKeyName​(java.lang.String keyName)
        Set the s3 key name.
        Parameters:
        keyName - the s3 key name
        Returns:
        builder

      • getBucketName

        public java.lang.String getBucketName()
        Get the s3 bucket name.
        Returns:
        the s3 bucket name

      • setBucketName

        public S3ConfigSourceBuilder setBucketName​(java.lang.String bucketName)
        Set the s3 bucket name.
        Parameters:
        bucketName - the s3 bucket name
        Returns:
        builder

      • build

        public org.github.gestalt.config.source.ConfigSourcePackage build()
                                                           throws org.github.gestalt.config.exceptions.GestaltException
        Specified by:
        build in class org.github.gestalt.config.builder.SourceBuilder<S3ConfigSourceBuilder,​S3ConfigSource>
        Throws:
        org.github.gestalt.config.exceptions.GestaltException