CloudFrontJava 2.x 用の SDK の使用例

次のコード例は、AWS SDK for Java 2.x with を使用してアクションを実行する方法を示していますCloudFront。

「アクション」は、個々のサービス関数の呼び出し方法を示すコードの抜粋です。

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

それぞれの例にはGitHub、へのリンクがあり、コンテキストでコードを設定および実行する方法についての説明が記載されています。

トピック

アクション
シナリオ

アクション

次のコード例は、CloudFrontディストリビューションを作成する方法を示しています。

SDK for Java 2.x

注記

他にもありますGitHub。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。

次の例では、Amazon Simple Storage Service (Amazon S3) バケットをコンテンツオリジンとして使用します。

ディストリビューションを作成すると、コードは () CloudFrontWaiterを作成して、ディストリビューションがデプロイされるまで待ってからディストリビューションを返します。



import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.core.internal.waiters.ResponseOrException;
import software.amazon.awssdk.services.cloudfront.CloudFrontClient;
import software.amazon.awssdk.services.cloudfront.model.CreateDistributionResponse;
import software.amazon.awssdk.services.cloudfront.model.Distribution;
import software.amazon.awssdk.services.cloudfront.model.GetDistributionResponse;
import software.amazon.awssdk.services.cloudfront.model.ItemSelection;
import software.amazon.awssdk.services.cloudfront.model.Method;
import software.amazon.awssdk.services.cloudfront.model.ViewerProtocolPolicy;
import software.amazon.awssdk.services.cloudfront.waiters.CloudFrontWaiter;
import software.amazon.awssdk.services.s3.S3Client;

import java.time.Instant;

public class CreateDistribution {

    private static final Logger logger = LoggerFactory.getLogger(CreateDistribution.class);

    public static Distribution createDistribution(CloudFrontClient cloudFrontClient, S3Client s3Client,
                                                  final String bucketName, final String keyGroupId, final String originAccessControlId) {

        final String region = s3Client.headBucket(b -> b.bucket(bucketName)).sdkHttpResponse().headers().get("x-amz-bucket-region").get(0);
        final String originDomain = bucketName + ".s3." + region + ".amazonaws.com";
        String originId = originDomain; // Use the originDomain value for the originId.

        // The service API requires some deprecated methods, such as DefaultCacheBehavior.Builder#minTTL and #forwardedValue.
        CreateDistributionResponse createDistResponse = cloudFrontClient.createDistribution(builder -> builder
                .distributionConfig(b1 -> b1
                        .origins(b2 -> b2
                                .quantity(1)
                                .items(b3 -> b3
                                        .domainName(originDomain)
                                        .id(originId)
                                        .s3OriginConfig(builder4 -> builder4.originAccessIdentity(""))
                                        .originAccessControlId(originAccessControlId)))
                        .defaultCacheBehavior(b2 -> b2
                                .viewerProtocolPolicy(ViewerProtocolPolicy.ALLOW_ALL)
                                .targetOriginId(originId)
                                .minTTL(200L)
                                .forwardedValues(b5 -> b5
                                        .cookies(cp -> cp
                                                .forward(ItemSelection.NONE))
                                        .queryString(true))
                                .trustedKeyGroups(b3 -> b3
                                        .quantity(1)
                                        .items(keyGroupId)
                                        .enabled(true))
                                .allowedMethods(b4 -> b4
                                        .quantity(2)
                                        .items(Method.HEAD, Method.GET)
                                        .cachedMethods(b5 -> b5
                                                .quantity(2)
                                                .items(Method.HEAD, Method.GET))))
                        .cacheBehaviors(b -> b
                                .quantity(1)
                                .items(b2 -> b2
                                        .pathPattern("/index.html")
                                        .viewerProtocolPolicy(ViewerProtocolPolicy.ALLOW_ALL)
                                        .targetOriginId(originId)
                                        .trustedKeyGroups(b3 -> b3
                                                .quantity(1)
                                                .items(keyGroupId)
                                                .enabled(true))
                                        .minTTL(200L)
                                        .forwardedValues(b4 -> b4
                                                .cookies(cp -> cp
                                                        .forward(ItemSelection.NONE))
                                                .queryString(true))
                                        .allowedMethods(b5 -> b5.
                                                quantity(2).
                                                items(Method.HEAD, Method.GET)
                                                .cachedMethods(b6 -> b6
                                                        .quantity(2)
                                                        .items(Method.HEAD, Method.GET)))))
                        .enabled(true)
                        .comment("Distribution built with java")
                        .callerReference(Instant.now().toString())
                ));

        final Distribution distribution = createDistResponse.distribution();
        logger.info("Distribution created. DomainName: [{}]  Id: [{}]", distribution.domainName(), distribution.id());
        logger.info("Waiting for distribution to be deployed ...");
        try (CloudFrontWaiter cfWaiter = CloudFrontWaiter.builder().client(cloudFrontClient).build()) {
            ResponseOrException<GetDistributionResponse> responseOrException =
                    cfWaiter.waitUntilDistributionDeployed(builder -> builder.id(distribution.id())).matched();
            responseOrException.response().orElseThrow(() -> new RuntimeException("Distribution not created"));
            logger.info("Distribution deployed. DomainName: [{}]  Id: [{}]", distribution.domainName(), distribution.id());
        }
        return distribution;
    }
}

API の詳細については、AWS SDK for Java 2.xAPI CreateDistributionリファレンスのを参照してください。

次のコード例は、Amazon Amazon Amazon Amazon Amazon Amazon Amazon Amazon Amazon Amazon AmazonCloudFront 関数を作成する方法を示しています。

SDK for Java 2.x

注記

他にもありますGitHub。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。


    public static String createNewFunction(CloudFrontClient cloudFrontClient, String functionName, String filePath) {

        try {

            InputStream fileIs = CreateFunction.class.getClassLoader().getResourceAsStream(filePath);
            SdkBytes functionCode = SdkBytes.fromInputStream(fileIs);

            FunctionConfig config = FunctionConfig.builder()
                .comment("Created by using the CloudFront Java API")
                .runtime(FunctionRuntime.CLOUDFRONT_JS_1_0)
                .build();

            CreateFunctionRequest functionRequest = CreateFunctionRequest.builder()
                .name(functionName)
                .functionCode(functionCode)
                .functionConfig(config)
                .build();

            CreateFunctionResponse response = cloudFrontClient.createFunction(functionRequest);
            return response.functionSummary().functionMetadata().functionARN();

        } catch (CloudFrontException e){
            System.err.println(e.getMessage());
            System.exit(1);
        }
        return "";
    }

API の詳細については、AWS SDK for Java 2.xAPI CreateFunctionリファレンスのを参照してください。

次のコード例は、署名付き URL と署名付き Cookie で使用できるキーグループを作成する方法を示しています。

SDK for Java 2.x

注記

他にもありますGitHub。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。

キーグループには、署名された URL または Cookie の検証に使用される公開鍵が少なくとも 1 つ必要です。


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.services.cloudfront.CloudFrontClient;

import java.util.UUID;

public class CreateKeyGroup {
    private static final Logger logger = LoggerFactory.getLogger(CreateKeyGroup.class);

    public static String createKeyGroup(CloudFrontClient cloudFrontClient, String publicKeyId) {
        String keyGroupId = cloudFrontClient.createKeyGroup(b -> b.
                        keyGroupConfig(c -> c
                                .items(publicKeyId)
                                .name("JavaKeyGroup"+ UUID.randomUUID())))
                .keyGroup().id();
        logger.info("KeyGroup created with ID: [{}]", keyGroupId);
        return keyGroupId;
    }
}

API の詳細については、AWS SDK for Java 2.xAPI CreateKeyGroupリファレンスのを参照してください。

次のコード例は、CloudFrontディストリビューションを削除する方法を示しています。

SDK for Java 2.x

注記

他にもありますGitHub。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。

次のコード例では、ディストリビューションを無効化に更新し、ウェイターを使用して変更がデプロイされるのを待ってから、ディストリビューションを削除します。


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.core.internal.waiters.ResponseOrException;
import software.amazon.awssdk.services.cloudfront.CloudFrontClient;
import software.amazon.awssdk.services.cloudfront.model.DeleteDistributionResponse;
import software.amazon.awssdk.services.cloudfront.model.DistributionConfig;
import software.amazon.awssdk.services.cloudfront.model.GetDistributionResponse;
import software.amazon.awssdk.services.cloudfront.waiters.CloudFrontWaiter;

public class DeleteDistribution {
    private static final Logger logger = LoggerFactory.getLogger(DeleteDistribution.class);

    public static void deleteDistribution(final CloudFrontClient cloudFrontClient, final String distributionId) {
        // First, disable the distribution by updating it.
        GetDistributionResponse response = cloudFrontClient.
                getDistribution(b -> b
                        .id(distributionId));
        String etag = response.eTag();
        DistributionConfig distConfig = response.distribution().distributionConfig();

        cloudFrontClient.updateDistribution(builder -> builder
                .id(distributionId)
                .distributionConfig(builder1 -> builder1
                        .cacheBehaviors(distConfig.cacheBehaviors())
                        .defaultCacheBehavior(distConfig.defaultCacheBehavior())
                        .enabled(false)
                        .origins(distConfig.origins())
                        .comment(distConfig.comment())
                        .callerReference(distConfig.callerReference())
                        .defaultCacheBehavior(distConfig.defaultCacheBehavior())
                        .priceClass(distConfig.priceClass())
                        .aliases(distConfig.aliases())
                        .logging(distConfig.logging())
                        .defaultRootObject(distConfig.defaultRootObject())
                        .customErrorResponses(distConfig.customErrorResponses())
                        .httpVersion(distConfig.httpVersion())
                        .isIPV6Enabled(distConfig.isIPV6Enabled())
                        .restrictions(distConfig.restrictions())
                        .viewerCertificate(distConfig.viewerCertificate())
                        .webACLId(distConfig.webACLId())
                        .originGroups(distConfig.originGroups()))
                .ifMatch(etag));

        logger.info("Distribution [{}] is DISABLED, waiting for deployment before deleting ...", distributionId);
        GetDistributionResponse distributionResponse;
        try (CloudFrontWaiter cfWaiter = CloudFrontWaiter.builder().client(cloudFrontClient).build()) {
            ResponseOrException<GetDistributionResponse> responseOrException =
                    cfWaiter.waitUntilDistributionDeployed(builder -> builder.id(distributionId)).matched();
            distributionResponse = responseOrException.response().orElseThrow(() -> new RuntimeException("Could not disable distribution"));
        }

        DeleteDistributionResponse deleteDistributionResponse = cloudFrontClient.deleteDistribution(builder -> builder
                .id(distributionId)
                .ifMatch(distributionResponse.eTag()));
        if ( deleteDistributionResponse.sdkHttpResponse().isSuccessful() ){
            logger.info("Distribution [{}] DELETED", distributionId);
        }
    }
}

API の詳細については、「AWS SDK for Java 2.x API リファレンス」の以下のトピックを参照してください。
- DeleteDistribution
- UpdateDistribution

次のコード例は、Amazon Simple Storage Service (Amazon S3) バケットで制限コンテンツにアクセスするために使用されるリソースを削除する方法を示しています。

SDK for Java 2.x

注記

他にもありますGitHub。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.services.cloudfront.CloudFrontClient;
import software.amazon.awssdk.services.cloudfront.model.DeleteKeyGroupResponse;
import software.amazon.awssdk.services.cloudfront.model.DeleteOriginAccessControlResponse;
import software.amazon.awssdk.services.cloudfront.model.DeletePublicKeyResponse;
import software.amazon.awssdk.services.cloudfront.model.GetKeyGroupResponse;
import software.amazon.awssdk.services.cloudfront.model.GetOriginAccessControlResponse;
import software.amazon.awssdk.services.cloudfront.model.GetPublicKeyResponse;

public class DeleteSigningResources {
    private static final Logger logger = LoggerFactory.getLogger(DeleteSigningResources.class);

    public static void deleteOriginAccessControl(final CloudFrontClient cloudFrontClient, final String originAccessControlId){
        GetOriginAccessControlResponse getResponse = cloudFrontClient.getOriginAccessControl(b -> b.id(originAccessControlId));
        DeleteOriginAccessControlResponse deleteResponse = cloudFrontClient.deleteOriginAccessControl(builder -> builder
                .id(originAccessControlId)
                .ifMatch(getResponse.eTag()));
        if ( deleteResponse.sdkHttpResponse().isSuccessful() ){
            logger.info("Successfully deleted Origin Access Control [{}]", originAccessControlId);
        }
    }

    public static void deleteKeyGroup(final CloudFrontClient cloudFrontClient, final String keyGroupId){

        GetKeyGroupResponse getResponse = cloudFrontClient.getKeyGroup(b -> b.id(keyGroupId));
        DeleteKeyGroupResponse deleteResponse = cloudFrontClient.deleteKeyGroup(builder -> builder
                .id(keyGroupId)
                .ifMatch(getResponse.eTag()));
        if ( deleteResponse.sdkHttpResponse().isSuccessful() ){
            logger.info("Successfully deleted Key Group [{}]", keyGroupId);
        }
    }

    public static void deletePublicKey(final CloudFrontClient cloudFrontClient, final String publicKeyId){
        GetPublicKeyResponse getResponse = cloudFrontClient.getPublicKey(b -> b.id(publicKeyId));

        DeletePublicKeyResponse deleteResponse = cloudFrontClient.deletePublicKey(builder -> builder
                .id(publicKeyId)
                .ifMatch(getResponse.eTag()));

        if (deleteResponse.sdkHttpResponse().isSuccessful()){
            logger.info("Successfully deleted Public Key [{}]", publicKeyId);
        }
    }
}

API の詳細については、「AWS SDK for Java 2.x API リファレンス」の以下のトピックを参照してください。

次のコード例は、AmazonCloudFront ディストリビューションを更新する方法を示しています。

SDK for Java 2.x

注記

他にもありますGitHub。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。


    public static void modDistribution(CloudFrontClient cloudFrontClient, String idVal) {

        try {
            // Get the Distribution to modify.
            GetDistributionRequest disRequest = GetDistributionRequest.builder()
                 .id(idVal)
                 .build();

            GetDistributionResponse response = cloudFrontClient.getDistribution(disRequest);
            Distribution disObject = response.distribution();
            DistributionConfig config = disObject.distributionConfig();

            // Create a new  DistributionConfig object and add new values to comment and aliases
            DistributionConfig config1 = DistributionConfig.builder()
                .aliases(config.aliases()) // You can pass in new values here
                .comment("New Comment")
                .cacheBehaviors(config.cacheBehaviors())
                .priceClass(config.priceClass())
                .defaultCacheBehavior(config.defaultCacheBehavior())
                .enabled(config.enabled())
                .callerReference(config.callerReference())
                .logging(config.logging())
                .originGroups(config.originGroups())
                .origins(config.origins())
                .restrictions(config.restrictions())
                .defaultRootObject(config.defaultRootObject())
                .webACLId(config.webACLId())
                .httpVersion(config.httpVersion())
                .viewerCertificate(config.viewerCertificate())
                .customErrorResponses(config.customErrorResponses())
                .build();

            UpdateDistributionRequest updateDistributionRequest = UpdateDistributionRequest.builder()
                .distributionConfig(config1)
                .id(disObject.id())
                .ifMatch(response.eTag())
                .build();

            cloudFrontClient.updateDistribution(updateDistributionRequest);

        } catch (CloudFrontException e){
            System.err.println(e.awsErrorDetails().errorMessage());
            System.exit(1);
        }
    }

API の詳細については、AWS SDK for Java 2.xAPI UpdateDistributionリファレンスのを参照してください。

次のコード例は、公開鍵をアップロードする方法を示しています。

SDK for Java 2.x

注記

他にもありますGitHub。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。

次のコード例では、公開鍵を読み込んで AmazonCloudFront にアップロードします。


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.services.cloudfront.CloudFrontClient;
import software.amazon.awssdk.services.cloudfront.model.CreatePublicKeyResponse;
import software.amazon.awssdk.utils.IoUtils;

import java.io.IOException;
import java.io.InputStream;
import java.util.UUID;

public class CreatePublicKey {
    private static final Logger logger = LoggerFactory.getLogger(CreatePublicKey.class);

    public static String createPublicKey(CloudFrontClient cloudFrontClient, String publicKeyFileName) {
        try (InputStream is = CreatePublicKey.class.getClassLoader().getResourceAsStream(publicKeyFileName)) {
            String publicKeyString = IoUtils.toUtf8String(is);
            CreatePublicKeyResponse createPublicKeyResponse = cloudFrontClient.createPublicKey(b -> b.
                    publicKeyConfig(c -> c
                            .name("JavaCreatedPublicKey" + UUID.randomUUID())
                            .encodedKey(publicKeyString)
                            .callerReference(UUID.randomUUID().toString())));
            String createdPublicKeyId = createPublicKeyResponse.publicKey().id();
            logger.info("Public key created with id: [{}]", createdPublicKeyId);
            return createdPublicKeyId;

        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}

API の詳細については、AWS SDK for Java 2.xAPI CreatePublicKeyリファレンスのを参照してください。

シナリオ

以下のコード例は、制限されたリソースへのアクセスを許可する署名付き URL と Cookie を作成し Web を作成し Web を作成し API を作成し API を作成し 1 つ示しています。

SDK for Java 2.x

注記

他にもありますGitHub。用例一覧を検索し、AWS コード例リポジトリでの設定と実行の方法を確認してください。

CannedSignerRequestクラスを使用して、定型ポリシーで URL または Cookie に署名します。


import software.amazon.awssdk.services.cloudfront.model.CannedSignerRequest;

import java.net.URL;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.time.Instant;
import java.time.temporal.ChronoUnit;

public class CreateCannedPolicyRequest {

    public static CannedSignerRequest createRequestForCannedPolicy(String distributionDomainName, String fileNameToUpload,
                                                                   String privateKeyFullPath, String publicKeyId) throws Exception{
        String protocol = "https";
        String resourcePath = "/" + fileNameToUpload;

        String cloudFrontUrl = new URL(protocol, distributionDomainName, resourcePath).toString();
        Instant expirationDate = Instant.now().plus(7, ChronoUnit.DAYS);
        Path path = Paths.get(privateKeyFullPath);

        return CannedSignerRequest.builder()
                .resourceUrl(cloudFrontUrl)
                .privateKey(path)
                .keyPairId(publicKeyId)
                .expirationDate(expirationDate)
                .build();
    }
}

CustomSignerRequestクラスを使用して、カスタムポリシーで URL または Cookie に署名します。activeDateipRangeおよびはオプションのメソッドです。


import software.amazon.awssdk.services.cloudfront.model.CustomSignerRequest;

import java.net.URL;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.time.Instant;
import java.time.temporal.ChronoUnit;

public class CreateCustomPolicyRequest {

    public static CustomSignerRequest createRequestForCustomPolicy(String distributionDomainName, String fileNameToUpload,
                                                                   String privateKeyFullPath, String publicKeyId) throws Exception {
        String protocol = "https";
        String resourcePath = "/" + fileNameToUpload;

        String cloudFrontUrl = new URL(protocol, distributionDomainName, resourcePath).toString();
        Instant expireDate = Instant.now().plus(7, ChronoUnit.DAYS);
        // URL will be accessible tomorrow using the signed URL.
        Instant activeDate = Instant.now().plus(1, ChronoUnit.DAYS);
        Path path = Paths.get(privateKeyFullPath);

        return CustomSignerRequest.builder()
                .resourceUrl(cloudFrontUrl)
                .privateKey(path)
                .keyPairId(publicKeyId)
                .expirationDate(expireDate)
                .activeDate(activeDate)      // Optional.
                //.ipRange("192.168.0.1/24") // Optional.
                .build();
    }
}

次の例は、CloudFrontUtilitiesクラスを使用して署名付き Cookie と URL を生成する方法を示しています。このコード例については、を参照してくださいGitHub。


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.services.cloudfront.CloudFrontUtilities;
import software.amazon.awssdk.services.cloudfront.cookie.CookiesForCannedPolicy;
import software.amazon.awssdk.services.cloudfront.cookie.CookiesForCustomPolicy;
import software.amazon.awssdk.services.cloudfront.model.CannedSignerRequest;
import software.amazon.awssdk.services.cloudfront.model.CustomSignerRequest;
import software.amazon.awssdk.services.cloudfront.url.SignedUrl;

public class SigningUtilities {
    private static final Logger logger = LoggerFactory.getLogger(SigningUtilities.class);
    private static final CloudFrontUtilities cloudFrontUtilities = CloudFrontUtilities.create();

    public static SignedUrl signUrlForCannedPolicy(CannedSignerRequest cannedSignerRequest){
        SignedUrl signedUrl = cloudFrontUtilities.getSignedUrlWithCannedPolicy(cannedSignerRequest);
        logger.info("Signed URL: [{}]", signedUrl.url());
        return signedUrl;
    }

    public static SignedUrl signUrlForCustomPolicy(CustomSignerRequest customSignerRequest){
        SignedUrl signedUrl = cloudFrontUtilities.getSignedUrlWithCustomPolicy(customSignerRequest);
        logger.info("Signed URL: [{}]", signedUrl.url());
        return signedUrl;
    }

    public static CookiesForCannedPolicy getCookiesForCannedPolicy(CannedSignerRequest cannedSignerRequest){
        CookiesForCannedPolicy cookiesForCannedPolicy = cloudFrontUtilities.getCookiesForCannedPolicy(cannedSignerRequest);
        logger.info("Cookie EXPIRES header [{}]", cookiesForCannedPolicy.expiresHeaderValue());
        logger.info("Cookie KEYPAIR header [{}]", cookiesForCannedPolicy.keyPairIdHeaderValue());
        logger.info("Cookie SIGNATURE header [{}]", cookiesForCannedPolicy.signatureHeaderValue());
        return cookiesForCannedPolicy;
    }

    public static CookiesForCustomPolicy getCookiesForCustomPolicy(CustomSignerRequest customSignerRequest) {
        CookiesForCustomPolicy cookiesForCustomPolicy = cloudFrontUtilities.getCookiesForCustomPolicy(customSignerRequest);
        logger.info("Cookie POLICY header [{}]", cookiesForCustomPolicy.policyHeaderValue());
        logger.info("Cookie KEYPAIR header [{}]", cookiesForCustomPolicy.keyPairIdHeaderValue());
        logger.info("Cookie SIGNATURE header [{}]", cookiesForCustomPolicy.signatureHeaderValue());
        return cookiesForCustomPolicy;
    }
}

API の詳細については、AWS SDK for Java 2.xAPI CloudFrontUtilitiesリファレンスのを参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Aurora

CloudWatch