software.amazon.awssdk.services.rds.RdsUtilities Maven / Gradle / Ivy

Go to download
/*
 * 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.rds;

import java.util.function.Consumer;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
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.rds.model.GenerateAuthenticationTokenRequest;

/**
 * Utilities for working with RDS. An instance of this class can be created by:
 * 
 * 1) Using the low-level client {@link RdsClient#utilities()} (or {@link RdsAsyncClient#utilities()}} method. This is
 * recommended as SDK will use the same configuration from the {@link RdsClient} object to create the {@link RdsUtilities} object.
 *
 * 
 * RdsClient rdsClient = RdsClient.create();
 * RdsUtilities utilities = rdsClient.utilities();
 * 
 * 
 *
 * 
 * 2) Directly using the {@link #builder()} method.
 *
 * 
 * RdsUtilities utilities = RdsUtilities.builder()
 *  .credentialsProvider(DefaultCredentialsProvider.create())
 *  .region(Region.US_WEST_2)
 *  .build()
 * 
 * 
 *
 * Note: This class does not make network calls.
 */
@SdkPublicApi
public interface RdsUtilities {
    /**
     * Create a builder that can be used to configure and create a {@link RdsUtilities}.
     */
    static Builder builder() {
        return new DefaultRdsUtilities.DefaultBuilder();
    }

    /**
     * Generates an authorization tokens for IAM authentication to an RDS database.
     *
     * @param request The request used to generate the auth token
     * @return String to use as the RDS auth token
     * @throws IllegalArgumentException if the required parameters are not valid
     */
    default String generateAuthenticationToken(Consumer request) {
        return generateAuthenticationToken(GenerateAuthenticationTokenRequest.builder().applyMutation(request).build());
    }

    /**
     * Generates an authorization tokens for IAM authentication to an RDS database.
     *
     * @param request The request used to generate the auth token
     * @return String to use as the RDS auth token
     * @throws IllegalArgumentException if the required parameters are not valid
     */
    default String generateAuthenticationToken(GenerateAuthenticationTokenRequest request) {
        throw new UnsupportedOperationException();
    }

    /**
     * Builder for creating an instance of {@link RdsUtilities}. It can be configured using {@link RdsUtilities#builder()}.
     * Once configured, the {@link RdsUtilities} can created using {@link #build()}.
     */
    @SdkPublicApi
    interface Builder {
        /**
         * The default region to use when working with the methods in {@link RdsUtilities} class.
         *
         * @return This object for method chaining
         */
        Builder region(Region region);

        /**
         * The default credentials provider to use when working with the methods in {@link RdsUtilities} class.
         *
         * @return This object for method chaining
         */
        default Builder credentialsProvider(AwsCredentialsProvider credentialsProvider) {
            return credentialsProvider((IdentityProvider) credentialsProvider);
        }

        /**
         * The default credentials provider to use when working with the methods in {@link RdsUtilities} class.
         *
         * @return This object for method chaining
         */
        default Builder credentialsProvider(IdentityProvider credentialsProvider) {
            throw new UnsupportedOperationException();
        }


        /**
         * Create a {@link RdsUtilities}
         */
        RdsUtilities build();
    }
}