AWS S3

# 
upload:
  # 
  s3:
    # Uploaders require a name.
    # 
    app:

      # Enables or disables the uploader.
      # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      # Defaults to `NEVER`.
      #  
      active: ALWAYS

      # Defines the connection timeout in seconds.
      # Defaults to `20`.
      # 
      connectTimeout: 20

      # Defines the read timeout in seconds.
      # Defaults to `60`.
      # 
      readTimeout: 60

      # Upload files.
      # Defaults to `true`.
      # 
      files: true

      # Upload distribution artifacts.
      # Defaults to `true`.
      # 
      artifacts: true

      # Release checksum files.
      # Defaults to `true`.
      # 
      checksums: true

      # Upload signatures.
      # Defaults to `true`.
      # 
      signatures: true

      # Upload catalogs.
      # Defaults to `true`.
      # 
      catalogs: true

      # Additional properties used when evaluating templates.
      # 
      extraProperties:
        # Key will be capitalized and prefixed with `s3`, i.e, `s3Foo`.
        foo: bar

      # The region where the S3 bucket is located.
      #  
      region: us-east-2

      # The name of the bucket.
      #  
      bucket: releases

      # The artifact path within the bucket.
      #   
      path: '{{projectName}}/{{tagName}}/{{artifactFile}}'

      # Custom download URL.
      # Required if a custom endpoint is defined.
      #   
      downloadUrl: 'https://{{bucket}}.s3.{{region}}.amazonaws.com/{{projectName}}/{{tagName}}/{{artifactFile}}'

      # The accessKeyId required for authorization.
      #  
      accessKeyId: __USE_ENVIRONMENT_VARIABLE__

      # The secretKey required for authorization.
      #  
      secretKey: __USE_ENVIRONMENT_VARIABLE__

      # The AWS sessionToken when you use temporal credentials.
      #  
      sessionToken: __USE_ENVIRONMENT_VARIABLE__

      # The endpoint to use for S3 service in case some other S3 compatible service is used.
      #  
      endpoint: 's3.{{region}}.example.com'

      # Additional headers to be sent to the server.
      # Values accept Name Templates.
      #  
      headers:
        'X-ARTIFACT-PLATFORM': '{{artifactPlatform}}'

# Uploaders require a name.
# 
[upload.s3.app]

  # Enables or disables the uploader.
  # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `NEVER`.
  #  
  active = "ALWAYS"

  # Defines the connection timeout in seconds.
  # Defaults to `20`.
  # 
  connectTimeout = 20

  # Defines the read timeout in seconds.
  # Defaults to `60`.
  # 
  readTimeout = 60

  # Upload files.
  # Defaults to `true`.
  # 
  files = true

  # Upload distribution artifacts.
  # Defaults to `true`.
  # 
  artifacts = true

  # Release checksum files.
  # Defaults to `true`.
  # 
  checksums = true

  # Upload signatures.
  # Defaults to `true`.
  # 
  signatures = true

  # Upload catalogs.
  # Defaults to `true`.
  # 
  catalogs = true

  # Additional properties used when evaluating templates.
  # 
  extraProperties.foo = "bar"
  # Key will be capitalized and prefixed with `s3`, i.e, `s3Foo`.

  # The region where the S3 bucket is located.
  #  
  region = "us-east-2"

  # The name of the bucket.
  #  
  bucket = "releases"

  # The artifact path within the bucket.
  #   
  path = "{{projectName}}/{{tagName}}/{{artifactFile}}"

  # Custom download URL.
  # Required if a custom endpoint is defined.
  #   
  downloadUrl = "https://{{bucket}}.s3.{{region}}.amazonaws.com/{{projectName}}/{{tagName}}/{{artifactFile}}"

  # The accessKeyId required for authorization.
  #  
  accessKeyId = "__USE_ENVIRONMENT_VARIABLE__"

  # The secretKey required for authorization.
  #  
  secretKey = "__USE_ENVIRONMENT_VARIABLE__"

  # The AWS sessionToken when you use temporal credentials.
  #  
  sessionToken = "__USE_ENVIRONMENT_VARIABLE__"

  # The endpoint to use for S3 service in case some other S3 compatible service is used.
  #  
  endpoint = "s3.{{region}}.example.com"

  # Additional headers to be sent to the server.
  # Values accept Name Templates.
  #  
  headers."X-ARTIFACT-PLATFORM" = "{{artifactPlatform}}"

{
  // 
  "upload": {
    // 
    "s3": {
      // Uploaders require a name.
      // 
      "app": {

        // Enables or disables the uploader.
        // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        // Defaults to `NEVER`.
        //  
        "active": "ALWAYS",

        // Defines the connection timeout in seconds.
        // Defaults to `20`.
        // 
        "connectTimeout": 20,

        // Defines the read timeout in seconds.
        // Defaults to `60`.
        // 
        "readTimeout": 60,

        // Upload files.
        // Defaults to `true`.
        // 
        "files": true,

        // Upload distribution artifacts.
        // Defaults to `true`.
        // 
        "artifacts": true,

        // Release checksum files.
        // Defaults to `true`.
        // 
        "checksums": true,

        // Upload signatures.
        // Defaults to `true`.
        // 
        "signatures": true,

        // Upload catalogs.
        // Defaults to `true`.
        // 
        "catalogs": true,

        // Additional properties used when evaluating templates.
        // 
        "extraProperties": {
          // Key will be capitalized and prefixed with `s3`, i.e, `s3Foo`.
          "foo": "bar"
        },

        // The region where the S3 bucket is located.
        //  
        "region": "us-east-2",

        // The name of the bucket.
        //  
        "bucket": "releases",

        // The artifact path within the bucket.
        //   
        "path": "{{projectName}}/{{tagName}}/{{artifactFile}}",

        // Custom download URL.
        // Required if a custom endpoint is defined.
        //   
        "downloadUrl": "https://{{bucket}}.s3.{{region}}.amazonaws.com/{{projectName}}/{{tagName}}/{{artifactFile}}",

        // The accessKeyId required for authorization.
        //  
        "accessKeyId": "__USE_ENVIRONMENT_VARIABLE__",

        // The secretKey required for authorization.
        //  
        "secretKey": "__USE_ENVIRONMENT_VARIABLE__",

        // The AWS sessionToken when you use temporal credentials.
        //  
        "sessionToken": "__USE_ENVIRONMENT_VARIABLE__",

        // The endpoint to use for S3 service in case some other S3 compatible service is used.
        //  
        "endpoint": "s3.{{region}}.example.com",

        // Additional headers to be sent to the server.
        // Values accept Name Templates.
        //  
        "headers": {
          "X-ARTIFACT-PLATFORM": "{{artifactPlatform}}"
        }
      }
    }
  }
}

<jreleaser>
  <!--
    
  -->
  <upload>
    <!--
      
    -->
    <s3>
      <!--
        Uploaders require a name.
        
      -->
      <app>
        <!--
          Enables or disables the distribution.
          Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
          Defaults to `NEVER`.
           
        -->
        <active>ALWAYS</active>

        <!--
          Defines the connection timeout in seconds.
          Defaults to `20`.
          
        -->
        <connectTimeout>20</connectTimeout>

        <!--
          Defines the read timeout in seconds.
          Defaults to `60`.
          
        -->
        <readTimeout>60</readTimeout>

        <!--
          Upload files.
          Defaults to `true`.
          
        -->
        <files>true</files>

        <!--
          Upload distribution artifacts.
          Defaults to `true`.
          
        -->
        <artifacts>true</artifacts>

        <!--
          Release checksum files.
          Defaults to `true`.
          
        -->
        <checksums>true</checksums>

        <!--
          Upload signatures.
          Defaults to `true`.
          
        -->
        <signatures>true</signatures>

        <!--
          Upload catalogs.
          Defaults to `true`.
          
        -->
        <catalogs>true</catalogs>

        <!--
          Additional properties used when evaluating templates.
          
        -->
        <extraProperties>
          <!--
            Key will be capitalized and prefixed with `s3`, i.e, `s3Foo`.
          -->
          <foo>bar</foo>
        </extraProperties>

        <!--
          The region where the S3 bucket is located.
           
        -->
        <region>us-east-2</region>

        <!--
          The name of the bucket.
           
        -->
        <bucket>releases</bucket>

        <!--
          The artifact path within the bucket.
            
        -->
        <path>{{projectName}}/{{tagName}}/{{artifactFile}}</path>

        <!--
          Custom download URL.
          Required if a custom endpoint is defined.
            
        -->
        <downloadUrl>https://{{bucket}}.s3.{{region}}.amazonaws.com/{{projectName}}/{{tagName}}/{{artifactFile}}</downloadUrl>

        <!--
          The accessKeyId required for authorization.
           
        -->
        <accessKeyId>__USE_ENVIRONMENT_VARIABLE__</accessKeyId>

        <!--
          The secretKey required for authorization.
           
        -->
        <secretKey>__USE_ENVIRONMENT_VARIABLE__</secretKey>

        <!--
          The AWS sessionToken when you use temporal credentials.
           
        -->
        <sessionToken>__USE_ENVIRONMENT_VARIABLE__</sessionToken>

        <!--
          The endpoint to use for S3 service in case some other S3 compatible service is used.
           
        -->
        <endpoint>s3.{{region}}.example.com</endpoint>

        <!--
          Additional headers to be sent to the server.
          Values accept Name Templates.
           
        -->
        <headers>
          <X-ARTIFACT-PLATFORM>{{artifactPlatform}}</X-ARTIFACT-PLATFORM>
        </headers>
      </app>
    </s3>
  </upload>
</jreleaser>

jreleaser {
  // 
  upload {
    // 
    s3 {
      // Uploaders require a name.
      // 
      app {

        // Enables or disables the uploader.
        // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        // Defaults to `NEVER`.
        //  
        active = 'ALWAYS'

        // Defines the connection timeout in seconds.
        // Defaults to `20`.
        // 
        connectTimeout = 20

        // Defines the read timeout in seconds.
        // Defaults to `60`.
        // 
        readTimeout = 60

        // Upload files.
        // Defaults to `true`.
        // 
        files = true

        // Upload distribution artifacts.
        // Defaults to `true`.
        // 
        artifacts = true

        // Release checksum files.
        // Defaults to `true`.
        // 
        checksums = true

        // Upload signatures.
        // Defaults to `true`.
        // 
        signatures = true

        // Upload catalogs.
        // Defaults to `true`.
        // 
        catalogs = true

        // Additional properties used when evaluating templates.
        // Key will be capitalized and prefixed with `s3`, i.e, `s3Foo`.
        // 
        extraProperties.put('foo', 'bar')

        // The region where the S3 bucket is located.
        //  
        region = 'us-east-2'

        // The name of the bucket.
        //  
        bucket = 'releases'

        // The artifact path within the bucket.
        //   
        path = '{{projectName}}/{{tagName}}/{{artifactFile}}'

        // Custom download URL.
        // Required if a custom endpoint is defined.
        //   
        downloadUrl = 'https://{{bucket}}.s3.{{region}}.amazonaws.com/{{projectName}}/{{tagName}}/{{artifactFile}}'

        // The accessKeyId required for authorization.
        //  
        accessKeyId = '__USE_ENVIRONMENT_VARIABLE__'

        // The secretKey required for authorization.
        //  
        secretKey = '__USE_ENVIRONMENT_VARIABLE__'

        // The AWS sessionToken when you use temporal credentials.
        //  
        sessionToken = '__USE_ENVIRONMENT_VARIABLE__'

        // The endpoint to use for S3 service in case some other S3 compatible service is used.
        //  
        endpoint = 's3.{{region}}.example.com'

        // Additional headers to be sent to the server.
        // Values accept Name Templates.
        //  
        headers.put('X-ARTIFACT-PLATFORM', '{{artifactPlatform}}')
      }
    }
  }
}