software.amazon.awssdk.services.s3.S3ServiceClientConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of s3 Show documentation
The AWS Java SDK for Amazon S3 module holds the client classes that are used for communicating with Amazon Simple Storage Service
There is a newer version: 2.28.3
Show newest version
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.services.s3;

import java.net.URI;
import java.util.Map;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.awscore.AwsServiceClientConfiguration;
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
import software.amazon.awssdk.endpoints.EndpointProvider;
import software.amazon.awssdk.http.auth.spi.scheme.AuthScheme;
import software.amazon.awssdk.identity.spi.AwsCredentialsIdentity;
import software.amazon.awssdk.identity.spi.IdentityProvider;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.auth.scheme.S3AuthSchemeProvider;
import software.amazon.awssdk.services.s3.internal.S3ServiceClientConfigurationBuilder;

/**
 * Class to expose the service client settings to the user. Implementation of {@link AwsServiceClientConfiguration}
 */
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
public final class S3ServiceClientConfiguration extends AwsServiceClientConfiguration {
    private final S3AuthSchemeProvider authSchemeProvider;

    private final Boolean crossRegionAccessEnabled;

    public S3ServiceClientConfiguration(Builder builder) {
        super(builder);
        this.authSchemeProvider = builder.authSchemeProvider();
        this.crossRegionAccessEnabled = builder.crossRegionAccessEnabled();
    }

    public static Builder builder() {
        return new S3ServiceClientConfigurationBuilder();
    }

    /**
     * Gets the value for auth scheme provider
     */
    public S3AuthSchemeProvider authSchemeProvider() {
        return authSchemeProvider;
    }

    /**
     * Gets the value for Enables cross-region bucket access for this client
     */
    public Boolean crossRegionAccessEnabled() {
        return crossRegionAccessEnabled;
    }

    /**
     * A builder for creating a {@link S3ServiceClientConfiguration}
     */
    public interface Builder extends AwsServiceClientConfiguration.Builder {
        /**
         * Sets the value for client override configuration
         */
        @Override
        Builder overrideConfiguration(ClientOverrideConfiguration overrideConfiguration);

        /**
         * Gets the value for client override configuration
         */
        @Override
        ClientOverrideConfiguration overrideConfiguration();

        /**
         * Sets the value for endpoint override
         */
        @Override
        Builder endpointOverride(URI endpointOverride);

        /**
         * Gets the value for endpoint override
         */
        @Override
        URI endpointOverride();

        /**
         * Sets the value for endpoint provider
         */
        @Override
        Builder endpointProvider(EndpointProvider endpointProvider);

        /**
         * Gets the value for endpoint provider
         */
        @Override
        EndpointProvider endpointProvider();

        /**
         * Sets the value for AWS region
         */
        @Override
        Builder region(Region region);

        /**
         * Gets the value for AWS region
         */
        @Override
        Region region();

        /**
         * Sets the value for credentials provider
         */
        @Override
        Builder credentialsProvider(IdentityProvider credentialsProvider);

        /**
         * Gets the value for credentials provider
         */
        @Override
        IdentityProvider credentialsProvider();

        @Override
        Builder putAuthScheme(AuthScheme authScheme);

        /**
         * Gets the value for auth schemes
         */
        @Override
        Map> authSchemes();

        /**
         * Sets the value for auth scheme provider
         */
        Builder authSchemeProvider(S3AuthSchemeProvider authSchemeProvider);

        /**
         * Gets the value for auth scheme provider
         */
        S3AuthSchemeProvider authSchemeProvider();

        /**
         * Sets the value for Enables cross-region bucket access for this client
         */
        Builder crossRegionAccessEnabled(Boolean crossRegionAccessEnabled);

        /**
         * Gets the value for Enables cross-region bucket access for this client
         */
        Boolean crossRegionAccessEnabled();

        @Override
        S3ServiceClientConfiguration build();
    }
}