com.adobe.testing.s3mock.S3MockProperties Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2017-2022 Adobe.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *          http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package com.adobe.testing.s3mock;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.bind.DefaultValue;
import software.amazon.awssdk.regions.Region;

@ConfigurationProperties("com.adobe.testing.s3mock")
public record S3MockProperties(
    // Property name for passing the HTTPS port to use. Defaults to
    // {@value S3MockApplication#DEFAULT_HTTPS_PORT}. If set to
    // {@value S3MockApplication#RANDOM_PORT}, a random port will be chosen.
    int httpPort,

    // Property name for passing the global context path to use.
    // Defaults to "".
    // For example if set to `s3-mock` all endpoints will be available at
    // `http://host:port/s3-mock` instead of `http://host:port/`
    @DefaultValue("")
    String contextPath,

    // Region is S3Mock is supposed to mock.
    // Must be an official AWS region string like "us-east-1"
    Region region
) {

}