Interface CloudFrontClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault AssociateAliasResponseassociateAlias(Consumer<AssociateAliasRequest.Builder> associateAliasRequest) Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.default AssociateAliasResponseassociateAlias(AssociateAliasRequest associateAliasRequest) Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.static CloudFrontClientBuilderbuilder()Create a builder that can be used to configure and create aCloudFrontClient.default CopyDistributionResponsecopyDistribution(Consumer<CopyDistributionRequest.Builder> copyDistributionRequest) Creates a staging distribution using the configuration of the provided primary distribution.default CopyDistributionResponsecopyDistribution(CopyDistributionRequest copyDistributionRequest) Creates a staging distribution using the configuration of the provided primary distribution.static CloudFrontClientcreate()Create aCloudFrontClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateCachePolicyResponsecreateCachePolicy(Consumer<CreateCachePolicyRequest.Builder> createCachePolicyRequest) Creates a cache policy.default CreateCachePolicyResponsecreateCachePolicy(CreateCachePolicyRequest createCachePolicyRequest) Creates a cache policy.createCloudFrontOriginAccessIdentity(Consumer<CreateCloudFrontOriginAccessIdentityRequest.Builder> createCloudFrontOriginAccessIdentityRequest) Creates a new origin access identity.createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest) Creates a new origin access identity.createContinuousDeploymentPolicy(Consumer<CreateContinuousDeploymentPolicyRequest.Builder> createContinuousDeploymentPolicyRequest) Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.createContinuousDeploymentPolicy(CreateContinuousDeploymentPolicyRequest createContinuousDeploymentPolicyRequest) Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.default CreateDistributionResponsecreateDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest) Creates a CloudFront distribution.default CreateDistributionResponsecreateDistribution(CreateDistributionRequest createDistributionRequest) Creates a CloudFront distribution.createDistributionWithTags(Consumer<CreateDistributionWithTagsRequest.Builder> createDistributionWithTagsRequest) Create a new distribution with tags.createDistributionWithTags(CreateDistributionWithTagsRequest createDistributionWithTagsRequest) Create a new distribution with tags.createFieldLevelEncryptionConfig(Consumer<CreateFieldLevelEncryptionConfigRequest.Builder> createFieldLevelEncryptionConfigRequest) Create a new field-level encryption configuration.createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest createFieldLevelEncryptionConfigRequest) Create a new field-level encryption configuration.createFieldLevelEncryptionProfile(Consumer<CreateFieldLevelEncryptionProfileRequest.Builder> createFieldLevelEncryptionProfileRequest) Create a field-level encryption profile.createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest createFieldLevelEncryptionProfileRequest) Create a field-level encryption profile.default CreateFunctionResponsecreateFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest) Creates a CloudFront function.default CreateFunctionResponsecreateFunction(CreateFunctionRequest createFunctionRequest) Creates a CloudFront function.default CreateInvalidationResponsecreateInvalidation(Consumer<CreateInvalidationRequest.Builder> createInvalidationRequest) Create a new invalidation.default CreateInvalidationResponsecreateInvalidation(CreateInvalidationRequest createInvalidationRequest) Create a new invalidation.default CreateKeyGroupResponsecreateKeyGroup(Consumer<CreateKeyGroupRequest.Builder> createKeyGroupRequest) Creates a key group that you can use with CloudFront signed URLs and signed cookies.default CreateKeyGroupResponsecreateKeyGroup(CreateKeyGroupRequest createKeyGroupRequest) Creates a key group that you can use with CloudFront signed URLs and signed cookies.default CreateKeyValueStoreResponsecreateKeyValueStore(Consumer<CreateKeyValueStoreRequest.Builder> createKeyValueStoreRequest) Specifies the key value store resource to add to your account.default CreateKeyValueStoreResponsecreateKeyValueStore(CreateKeyValueStoreRequest createKeyValueStoreRequest) Specifies the key value store resource to add to your account.createMonitoringSubscription(Consumer<CreateMonitoringSubscriptionRequest.Builder> createMonitoringSubscriptionRequest) Enables additional CloudWatch metrics for the specified CloudFront distribution.createMonitoringSubscription(CreateMonitoringSubscriptionRequest createMonitoringSubscriptionRequest) Enables additional CloudWatch metrics for the specified CloudFront distribution.createOriginAccessControl(Consumer<CreateOriginAccessControlRequest.Builder> createOriginAccessControlRequest) Creates a new origin access control in CloudFront.createOriginAccessControl(CreateOriginAccessControlRequest createOriginAccessControlRequest) Creates a new origin access control in CloudFront.createOriginRequestPolicy(Consumer<CreateOriginRequestPolicyRequest.Builder> createOriginRequestPolicyRequest) Creates an origin request policy.createOriginRequestPolicy(CreateOriginRequestPolicyRequest createOriginRequestPolicyRequest) Creates an origin request policy.default CreatePublicKeyResponsecreatePublicKey(Consumer<CreatePublicKeyRequest.Builder> createPublicKeyRequest) Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.default CreatePublicKeyResponsecreatePublicKey(CreatePublicKeyRequest createPublicKeyRequest) Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.default CreateRealtimeLogConfigResponsecreateRealtimeLogConfig(Consumer<CreateRealtimeLogConfigRequest.Builder> createRealtimeLogConfigRequest) Creates a real-time log configuration.default CreateRealtimeLogConfigResponsecreateRealtimeLogConfig(CreateRealtimeLogConfigRequest createRealtimeLogConfigRequest) Creates a real-time log configuration.createResponseHeadersPolicy(Consumer<CreateResponseHeadersPolicyRequest.Builder> createResponseHeadersPolicyRequest) Creates a response headers policy.createResponseHeadersPolicy(CreateResponseHeadersPolicyRequest createResponseHeadersPolicyRequest) Creates a response headers policy.createStreamingDistribution(Consumer<CreateStreamingDistributionRequest.Builder> createStreamingDistributionRequest) This API is deprecated.createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest) This API is deprecated.createStreamingDistributionWithTags(Consumer<CreateStreamingDistributionWithTagsRequest.Builder> createStreamingDistributionWithTagsRequest) This API is deprecated.createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest) This API is deprecated.default DeleteCachePolicyResponsedeleteCachePolicy(Consumer<DeleteCachePolicyRequest.Builder> deleteCachePolicyRequest) Deletes a cache policy.default DeleteCachePolicyResponsedeleteCachePolicy(DeleteCachePolicyRequest deleteCachePolicyRequest) Deletes a cache policy.deleteCloudFrontOriginAccessIdentity(Consumer<DeleteCloudFrontOriginAccessIdentityRequest.Builder> deleteCloudFrontOriginAccessIdentityRequest) Delete an origin access identity.deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest) Delete an origin access identity.deleteContinuousDeploymentPolicy(Consumer<DeleteContinuousDeploymentPolicyRequest.Builder> deleteContinuousDeploymentPolicyRequest) Deletes a continuous deployment policy.deleteContinuousDeploymentPolicy(DeleteContinuousDeploymentPolicyRequest deleteContinuousDeploymentPolicyRequest) Deletes a continuous deployment policy.default DeleteDistributionResponsedeleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest) Delete a distribution.default DeleteDistributionResponsedeleteDistribution(DeleteDistributionRequest deleteDistributionRequest) Delete a distribution.deleteFieldLevelEncryptionConfig(Consumer<DeleteFieldLevelEncryptionConfigRequest.Builder> deleteFieldLevelEncryptionConfigRequest) Remove a field-level encryption configuration.deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest deleteFieldLevelEncryptionConfigRequest) Remove a field-level encryption configuration.deleteFieldLevelEncryptionProfile(Consumer<DeleteFieldLevelEncryptionProfileRequest.Builder> deleteFieldLevelEncryptionProfileRequest) Remove a field-level encryption profile.deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest deleteFieldLevelEncryptionProfileRequest) Remove a field-level encryption profile.default DeleteFunctionResponsedeleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest) Deletes a CloudFront function.default DeleteFunctionResponsedeleteFunction(DeleteFunctionRequest deleteFunctionRequest) Deletes a CloudFront function.default DeleteKeyGroupResponsedeleteKeyGroup(Consumer<DeleteKeyGroupRequest.Builder> deleteKeyGroupRequest) Deletes a key group.default DeleteKeyGroupResponsedeleteKeyGroup(DeleteKeyGroupRequest deleteKeyGroupRequest) Deletes a key group.default DeleteKeyValueStoreResponsedeleteKeyValueStore(Consumer<DeleteKeyValueStoreRequest.Builder> deleteKeyValueStoreRequest) Specifies the key value store to delete.default DeleteKeyValueStoreResponsedeleteKeyValueStore(DeleteKeyValueStoreRequest deleteKeyValueStoreRequest) Specifies the key value store to delete.deleteMonitoringSubscription(Consumer<DeleteMonitoringSubscriptionRequest.Builder> deleteMonitoringSubscriptionRequest) Disables additional CloudWatch metrics for the specified CloudFront distribution.deleteMonitoringSubscription(DeleteMonitoringSubscriptionRequest deleteMonitoringSubscriptionRequest) Disables additional CloudWatch metrics for the specified CloudFront distribution.deleteOriginAccessControl(Consumer<DeleteOriginAccessControlRequest.Builder> deleteOriginAccessControlRequest) Deletes a CloudFront origin access control.deleteOriginAccessControl(DeleteOriginAccessControlRequest deleteOriginAccessControlRequest) Deletes a CloudFront origin access control.deleteOriginRequestPolicy(Consumer<DeleteOriginRequestPolicyRequest.Builder> deleteOriginRequestPolicyRequest) Deletes an origin request policy.deleteOriginRequestPolicy(DeleteOriginRequestPolicyRequest deleteOriginRequestPolicyRequest) Deletes an origin request policy.default DeletePublicKeyResponsedeletePublicKey(Consumer<DeletePublicKeyRequest.Builder> deletePublicKeyRequest) Remove a public key you previously added to CloudFront.default DeletePublicKeyResponsedeletePublicKey(DeletePublicKeyRequest deletePublicKeyRequest) Remove a public key you previously added to CloudFront.default DeleteRealtimeLogConfigResponsedeleteRealtimeLogConfig(Consumer<DeleteRealtimeLogConfigRequest.Builder> deleteRealtimeLogConfigRequest) Deletes a real-time log configuration.default DeleteRealtimeLogConfigResponsedeleteRealtimeLogConfig(DeleteRealtimeLogConfigRequest deleteRealtimeLogConfigRequest) Deletes a real-time log configuration.deleteResponseHeadersPolicy(Consumer<DeleteResponseHeadersPolicyRequest.Builder> deleteResponseHeadersPolicyRequest) Deletes a response headers policy.deleteResponseHeadersPolicy(DeleteResponseHeadersPolicyRequest deleteResponseHeadersPolicyRequest) Deletes a response headers policy.deleteStreamingDistribution(Consumer<DeleteStreamingDistributionRequest.Builder> deleteStreamingDistributionRequest) Delete a streaming distribution.deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest) Delete a streaming distribution.default DescribeFunctionResponsedescribeFunction(Consumer<DescribeFunctionRequest.Builder> describeFunctionRequest) Gets configuration information and metadata about a CloudFront function, but not the function's code.default DescribeFunctionResponsedescribeFunction(DescribeFunctionRequest describeFunctionRequest) Gets configuration information and metadata about a CloudFront function, but not the function's code.default DescribeKeyValueStoreResponsedescribeKeyValueStore(Consumer<DescribeKeyValueStoreRequest.Builder> describeKeyValueStoreRequest) Specifies the key value store and its configuration.default DescribeKeyValueStoreResponsedescribeKeyValueStore(DescribeKeyValueStoreRequest describeKeyValueStoreRequest) Specifies the key value store and its configuration.default GetCachePolicyResponsegetCachePolicy(Consumer<GetCachePolicyRequest.Builder> getCachePolicyRequest) Gets a cache policy, including the following metadata:default GetCachePolicyResponsegetCachePolicy(GetCachePolicyRequest getCachePolicyRequest) Gets a cache policy, including the following metadata:default GetCachePolicyConfigResponsegetCachePolicyConfig(Consumer<GetCachePolicyConfigRequest.Builder> getCachePolicyConfigRequest) Gets a cache policy configuration.default GetCachePolicyConfigResponsegetCachePolicyConfig(GetCachePolicyConfigRequest getCachePolicyConfigRequest) Gets a cache policy configuration.getCloudFrontOriginAccessIdentity(Consumer<GetCloudFrontOriginAccessIdentityRequest.Builder> getCloudFrontOriginAccessIdentityRequest) Get the information about an origin access identity.getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest) Get the information about an origin access identity.getCloudFrontOriginAccessIdentityConfig(Consumer<GetCloudFrontOriginAccessIdentityConfigRequest.Builder> getCloudFrontOriginAccessIdentityConfigRequest) Get the configuration information about an origin access identity.getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest) Get the configuration information about an origin access identity.getContinuousDeploymentPolicy(Consumer<GetContinuousDeploymentPolicyRequest.Builder> getContinuousDeploymentPolicyRequest) Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).getContinuousDeploymentPolicy(GetContinuousDeploymentPolicyRequest getContinuousDeploymentPolicyRequest) Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).getContinuousDeploymentPolicyConfig(Consumer<GetContinuousDeploymentPolicyConfigRequest.Builder> getContinuousDeploymentPolicyConfigRequest) Gets configuration information about a continuous deployment policy.getContinuousDeploymentPolicyConfig(GetContinuousDeploymentPolicyConfigRequest getContinuousDeploymentPolicyConfigRequest) Gets configuration information about a continuous deployment policy.default GetDistributionResponsegetDistribution(Consumer<GetDistributionRequest.Builder> getDistributionRequest) Get the information about a distribution.default GetDistributionResponsegetDistribution(GetDistributionRequest getDistributionRequest) Get the information about a distribution.default GetDistributionConfigResponsegetDistributionConfig(Consumer<GetDistributionConfigRequest.Builder> getDistributionConfigRequest) Get the configuration information about a distribution.default GetDistributionConfigResponsegetDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest) Get the configuration information about a distribution.default GetFieldLevelEncryptionResponsegetFieldLevelEncryption(Consumer<GetFieldLevelEncryptionRequest.Builder> getFieldLevelEncryptionRequest) Get the field-level encryption configuration information.default GetFieldLevelEncryptionResponsegetFieldLevelEncryption(GetFieldLevelEncryptionRequest getFieldLevelEncryptionRequest) Get the field-level encryption configuration information.getFieldLevelEncryptionConfig(Consumer<GetFieldLevelEncryptionConfigRequest.Builder> getFieldLevelEncryptionConfigRequest) Get the field-level encryption configuration information.getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest getFieldLevelEncryptionConfigRequest) Get the field-level encryption configuration information.getFieldLevelEncryptionProfile(Consumer<GetFieldLevelEncryptionProfileRequest.Builder> getFieldLevelEncryptionProfileRequest) Get the field-level encryption profile information.getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest getFieldLevelEncryptionProfileRequest) Get the field-level encryption profile information.getFieldLevelEncryptionProfileConfig(Consumer<GetFieldLevelEncryptionProfileConfigRequest.Builder> getFieldLevelEncryptionProfileConfigRequest) Get the field-level encryption profile configuration information.getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest getFieldLevelEncryptionProfileConfigRequest) Get the field-level encryption profile configuration information.default GetFunctionResponsegetFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest) Gets the code of a CloudFront function.default GetFunctionResponsegetFunction(GetFunctionRequest getFunctionRequest) Gets the code of a CloudFront function.default GetInvalidationResponsegetInvalidation(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest) Get the information about an invalidation.default GetInvalidationResponsegetInvalidation(GetInvalidationRequest getInvalidationRequest) Get the information about an invalidation.default GetKeyGroupResponsegetKeyGroup(Consumer<GetKeyGroupRequest.Builder> getKeyGroupRequest) Gets a key group, including the date and time when the key group was last modified.default GetKeyGroupResponsegetKeyGroup(GetKeyGroupRequest getKeyGroupRequest) Gets a key group, including the date and time when the key group was last modified.default GetKeyGroupConfigResponsegetKeyGroupConfig(Consumer<GetKeyGroupConfigRequest.Builder> getKeyGroupConfigRequest) Gets a key group configuration.default GetKeyGroupConfigResponsegetKeyGroupConfig(GetKeyGroupConfigRequest getKeyGroupConfigRequest) Gets a key group configuration.getMonitoringSubscription(Consumer<GetMonitoringSubscriptionRequest.Builder> getMonitoringSubscriptionRequest) Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.getMonitoringSubscription(GetMonitoringSubscriptionRequest getMonitoringSubscriptionRequest) Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.default GetOriginAccessControlResponsegetOriginAccessControl(Consumer<GetOriginAccessControlRequest.Builder> getOriginAccessControlRequest) Gets a CloudFront origin access control, including its unique identifier.default GetOriginAccessControlResponsegetOriginAccessControl(GetOriginAccessControlRequest getOriginAccessControlRequest) Gets a CloudFront origin access control, including its unique identifier.getOriginAccessControlConfig(Consumer<GetOriginAccessControlConfigRequest.Builder> getOriginAccessControlConfigRequest) Gets a CloudFront origin access control configuration.getOriginAccessControlConfig(GetOriginAccessControlConfigRequest getOriginAccessControlConfigRequest) Gets a CloudFront origin access control configuration.default GetOriginRequestPolicyResponsegetOriginRequestPolicy(Consumer<GetOriginRequestPolicyRequest.Builder> getOriginRequestPolicyRequest) Gets an origin request policy, including the following metadata:default GetOriginRequestPolicyResponsegetOriginRequestPolicy(GetOriginRequestPolicyRequest getOriginRequestPolicyRequest) Gets an origin request policy, including the following metadata:getOriginRequestPolicyConfig(Consumer<GetOriginRequestPolicyConfigRequest.Builder> getOriginRequestPolicyConfigRequest) Gets an origin request policy configuration.getOriginRequestPolicyConfig(GetOriginRequestPolicyConfigRequest getOriginRequestPolicyConfigRequest) Gets an origin request policy configuration.default GetPublicKeyResponsegetPublicKey(Consumer<GetPublicKeyRequest.Builder> getPublicKeyRequest) Gets a public key.default GetPublicKeyResponsegetPublicKey(GetPublicKeyRequest getPublicKeyRequest) Gets a public key.default GetPublicKeyConfigResponsegetPublicKeyConfig(Consumer<GetPublicKeyConfigRequest.Builder> getPublicKeyConfigRequest) Gets a public key configuration.default GetPublicKeyConfigResponsegetPublicKeyConfig(GetPublicKeyConfigRequest getPublicKeyConfigRequest) Gets a public key configuration.default GetRealtimeLogConfigResponsegetRealtimeLogConfig(Consumer<GetRealtimeLogConfigRequest.Builder> getRealtimeLogConfigRequest) Gets a real-time log configuration.default GetRealtimeLogConfigResponsegetRealtimeLogConfig(GetRealtimeLogConfigRequest getRealtimeLogConfigRequest) Gets a real-time log configuration.default GetResponseHeadersPolicyResponsegetResponseHeadersPolicy(Consumer<GetResponseHeadersPolicyRequest.Builder> getResponseHeadersPolicyRequest) Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).default GetResponseHeadersPolicyResponsegetResponseHeadersPolicy(GetResponseHeadersPolicyRequest getResponseHeadersPolicyRequest) Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).getResponseHeadersPolicyConfig(Consumer<GetResponseHeadersPolicyConfigRequest.Builder> getResponseHeadersPolicyConfigRequest) Gets a response headers policy configuration.getResponseHeadersPolicyConfig(GetResponseHeadersPolicyConfigRequest getResponseHeadersPolicyConfigRequest) Gets a response headers policy configuration.default GetStreamingDistributionResponsegetStreamingDistribution(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest) Gets information about a specified RTMP distribution, including the distribution configuration.default GetStreamingDistributionResponsegetStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest) Gets information about a specified RTMP distribution, including the distribution configuration.getStreamingDistributionConfig(Consumer<GetStreamingDistributionConfigRequest.Builder> getStreamingDistributionConfigRequest) Get the configuration information about a streaming distribution.getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest) Get the configuration information about a streaming distribution.default ListCachePoliciesResponselistCachePolicies(Consumer<ListCachePoliciesRequest.Builder> listCachePoliciesRequest) Gets a list of cache policies.default ListCachePoliciesResponselistCachePolicies(ListCachePoliciesRequest listCachePoliciesRequest) Gets a list of cache policies.Lists origin access identities.listCloudFrontOriginAccessIdentities(Consumer<ListCloudFrontOriginAccessIdentitiesRequest.Builder> listCloudFrontOriginAccessIdentitiesRequest) Lists origin access identities.listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest) Lists origin access identities.default ListConflictingAliasesResponselistConflictingAliases(Consumer<ListConflictingAliasesRequest.Builder> listConflictingAliasesRequest) Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias.default ListConflictingAliasesResponselistConflictingAliases(ListConflictingAliasesRequest listConflictingAliasesRequest) Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias.listContinuousDeploymentPolicies(Consumer<ListContinuousDeploymentPoliciesRequest.Builder> listContinuousDeploymentPoliciesRequest) Gets a list of the continuous deployment policies in your Amazon Web Services account.listContinuousDeploymentPolicies(ListContinuousDeploymentPoliciesRequest listContinuousDeploymentPoliciesRequest) Gets a list of the continuous deployment policies in your Amazon Web Services account.default ListDistributionsResponseList CloudFront distributions.default ListDistributionsResponselistDistributions(Consumer<ListDistributionsRequest.Builder> listDistributionsRequest) List CloudFront distributions.default ListDistributionsResponselistDistributions(ListDistributionsRequest listDistributionsRequest) List CloudFront distributions.listDistributionsByCachePolicyId(Consumer<ListDistributionsByCachePolicyIdRequest.Builder> listDistributionsByCachePolicyIdRequest) Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.listDistributionsByCachePolicyId(ListDistributionsByCachePolicyIdRequest listDistributionsByCachePolicyIdRequest) Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.listDistributionsByKeyGroup(Consumer<ListDistributionsByKeyGroupRequest.Builder> listDistributionsByKeyGroupRequest) Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.listDistributionsByKeyGroup(ListDistributionsByKeyGroupRequest listDistributionsByKeyGroupRequest) Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.listDistributionsByOriginRequestPolicyId(Consumer<ListDistributionsByOriginRequestPolicyIdRequest.Builder> listDistributionsByOriginRequestPolicyIdRequest) Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.listDistributionsByOriginRequestPolicyId(ListDistributionsByOriginRequestPolicyIdRequest listDistributionsByOriginRequestPolicyIdRequest) Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.listDistributionsByRealtimeLogConfig(Consumer<ListDistributionsByRealtimeLogConfigRequest.Builder> listDistributionsByRealtimeLogConfigRequest) Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.listDistributionsByRealtimeLogConfig(ListDistributionsByRealtimeLogConfigRequest listDistributionsByRealtimeLogConfigRequest) Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.listDistributionsByResponseHeadersPolicyId(Consumer<ListDistributionsByResponseHeadersPolicyIdRequest.Builder> listDistributionsByResponseHeadersPolicyIdRequest) Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.listDistributionsByResponseHeadersPolicyId(ListDistributionsByResponseHeadersPolicyIdRequest listDistributionsByResponseHeadersPolicyIdRequest) Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.listDistributionsByWebACLId(Consumer<ListDistributionsByWebAclIdRequest.Builder> listDistributionsByWebAclIdRequest) List the distributions that are associated with a specified WAF web ACL.listDistributionsByWebACLId(ListDistributionsByWebAclIdRequest listDistributionsByWebAclIdRequest) List the distributions that are associated with a specified WAF web ACL.List all field-level encryption configurations that have been created in CloudFront for this account.listFieldLevelEncryptionConfigs(Consumer<ListFieldLevelEncryptionConfigsRequest.Builder> listFieldLevelEncryptionConfigsRequest) List all field-level encryption configurations that have been created in CloudFront for this account.listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest listFieldLevelEncryptionConfigsRequest) List all field-level encryption configurations that have been created in CloudFront for this account.Request a list of field-level encryption profiles that have been created in CloudFront for this account.listFieldLevelEncryptionProfiles(Consumer<ListFieldLevelEncryptionProfilesRequest.Builder> listFieldLevelEncryptionProfilesRequest) Request a list of field-level encryption profiles that have been created in CloudFront for this account.listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest listFieldLevelEncryptionProfilesRequest) Request a list of field-level encryption profiles that have been created in CloudFront for this account.default ListFunctionsResponselistFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) Gets a list of all CloudFront functions in your Amazon Web Services account.default ListFunctionsResponselistFunctions(ListFunctionsRequest listFunctionsRequest) Gets a list of all CloudFront functions in your Amazon Web Services account.default ListInvalidationsResponselistInvalidations(Consumer<ListInvalidationsRequest.Builder> listInvalidationsRequest) Lists invalidation batches.default ListInvalidationsResponselistInvalidations(ListInvalidationsRequest listInvalidationsRequest) Lists invalidation batches.default ListKeyGroupsResponselistKeyGroups(Consumer<ListKeyGroupsRequest.Builder> listKeyGroupsRequest) Gets a list of key groups.default ListKeyGroupsResponselistKeyGroups(ListKeyGroupsRequest listKeyGroupsRequest) Gets a list of key groups.default ListKeyValueStoresResponselistKeyValueStores(Consumer<ListKeyValueStoresRequest.Builder> listKeyValueStoresRequest) Specifies the key value stores to list.default ListKeyValueStoresResponselistKeyValueStores(ListKeyValueStoresRequest listKeyValueStoresRequest) Specifies the key value stores to list.default ListOriginAccessControlsResponselistOriginAccessControls(Consumer<ListOriginAccessControlsRequest.Builder> listOriginAccessControlsRequest) Gets the list of CloudFront origin access controls in this Amazon Web Services account.default ListOriginAccessControlsResponselistOriginAccessControls(ListOriginAccessControlsRequest listOriginAccessControlsRequest) Gets the list of CloudFront origin access controls in this Amazon Web Services account.listOriginRequestPolicies(Consumer<ListOriginRequestPoliciesRequest.Builder> listOriginRequestPoliciesRequest) Gets a list of origin request policies.listOriginRequestPolicies(ListOriginRequestPoliciesRequest listOriginRequestPoliciesRequest) Gets a list of origin request policies.default ListPublicKeysResponseList all public keys that have been added to CloudFront for this account.default ListPublicKeysResponselistPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) List all public keys that have been added to CloudFront for this account.default ListPublicKeysResponselistPublicKeys(ListPublicKeysRequest listPublicKeysRequest) List all public keys that have been added to CloudFront for this account.default ListRealtimeLogConfigsResponselistRealtimeLogConfigs(Consumer<ListRealtimeLogConfigsRequest.Builder> listRealtimeLogConfigsRequest) Gets a list of real-time log configurations.default ListRealtimeLogConfigsResponselistRealtimeLogConfigs(ListRealtimeLogConfigsRequest listRealtimeLogConfigsRequest) Gets a list of real-time log configurations.listResponseHeadersPolicies(Consumer<ListResponseHeadersPoliciesRequest.Builder> listResponseHeadersPoliciesRequest) Gets a list of response headers policies.listResponseHeadersPolicies(ListResponseHeadersPoliciesRequest listResponseHeadersPoliciesRequest) Gets a list of response headers policies.List streaming distributions.listStreamingDistributions(Consumer<ListStreamingDistributionsRequest.Builder> listStreamingDistributionsRequest) List streaming distributions.listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest) List streaming distributions.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List tags for a CloudFront resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List tags for a CloudFront resource.default PublishFunctionResponsepublishFunction(Consumer<PublishFunctionRequest.Builder> publishFunctionRequest) Publishes a CloudFront function by copying the function code from theDEVELOPMENTstage toLIVE.default PublishFunctionResponsepublishFunction(PublishFunctionRequest publishFunctionRequest) Publishes a CloudFront function by copying the function code from theDEVELOPMENTstage toLIVE.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add tags to a CloudFront resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Add tags to a CloudFront resource.default TestFunctionResponsetestFunction(Consumer<TestFunctionRequest.Builder> testFunctionRequest) Tests a CloudFront function.default TestFunctionResponsetestFunction(TestFunctionRequest testFunctionRequest) Tests a CloudFront function.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from a CloudFront resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Remove tags from a CloudFront resource.default UpdateCachePolicyResponseupdateCachePolicy(Consumer<UpdateCachePolicyRequest.Builder> updateCachePolicyRequest) Updates a cache policy configuration.default UpdateCachePolicyResponseupdateCachePolicy(UpdateCachePolicyRequest updateCachePolicyRequest) Updates a cache policy configuration.updateCloudFrontOriginAccessIdentity(Consumer<UpdateCloudFrontOriginAccessIdentityRequest.Builder> updateCloudFrontOriginAccessIdentityRequest) Update an origin access identity.updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest) Update an origin access identity.updateContinuousDeploymentPolicy(Consumer<UpdateContinuousDeploymentPolicyRequest.Builder> updateContinuousDeploymentPolicyRequest) Updates a continuous deployment policy.updateContinuousDeploymentPolicy(UpdateContinuousDeploymentPolicyRequest updateContinuousDeploymentPolicyRequest) Updates a continuous deployment policy.default UpdateDistributionResponseupdateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest) Updates the configuration for a CloudFront distribution.default UpdateDistributionResponseupdateDistribution(UpdateDistributionRequest updateDistributionRequest) Updates the configuration for a CloudFront distribution.updateDistributionWithStagingConfig(Consumer<UpdateDistributionWithStagingConfigRequest.Builder> updateDistributionWithStagingConfigRequest) Copies the staging distribution's configuration to its corresponding primary distribution.updateDistributionWithStagingConfig(UpdateDistributionWithStagingConfigRequest updateDistributionWithStagingConfigRequest) Copies the staging distribution's configuration to its corresponding primary distribution.updateFieldLevelEncryptionConfig(Consumer<UpdateFieldLevelEncryptionConfigRequest.Builder> updateFieldLevelEncryptionConfigRequest) Update a field-level encryption configuration.updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest updateFieldLevelEncryptionConfigRequest) Update a field-level encryption configuration.updateFieldLevelEncryptionProfile(Consumer<UpdateFieldLevelEncryptionProfileRequest.Builder> updateFieldLevelEncryptionProfileRequest) Update a field-level encryption profile.updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest updateFieldLevelEncryptionProfileRequest) Update a field-level encryption profile.default UpdateFunctionResponseupdateFunction(Consumer<UpdateFunctionRequest.Builder> updateFunctionRequest) Updates a CloudFront function.default UpdateFunctionResponseupdateFunction(UpdateFunctionRequest updateFunctionRequest) Updates a CloudFront function.default UpdateKeyGroupResponseupdateKeyGroup(Consumer<UpdateKeyGroupRequest.Builder> updateKeyGroupRequest) Updates a key group.default UpdateKeyGroupResponseupdateKeyGroup(UpdateKeyGroupRequest updateKeyGroupRequest) Updates a key group.default UpdateKeyValueStoreResponseupdateKeyValueStore(Consumer<UpdateKeyValueStoreRequest.Builder> updateKeyValueStoreRequest) Specifies the key value store to update.default UpdateKeyValueStoreResponseupdateKeyValueStore(UpdateKeyValueStoreRequest updateKeyValueStoreRequest) Specifies the key value store to update.updateOriginAccessControl(Consumer<UpdateOriginAccessControlRequest.Builder> updateOriginAccessControlRequest) Updates a CloudFront origin access control.updateOriginAccessControl(UpdateOriginAccessControlRequest updateOriginAccessControlRequest) Updates a CloudFront origin access control.updateOriginRequestPolicy(Consumer<UpdateOriginRequestPolicyRequest.Builder> updateOriginRequestPolicyRequest) Updates an origin request policy configuration.updateOriginRequestPolicy(UpdateOriginRequestPolicyRequest updateOriginRequestPolicyRequest) Updates an origin request policy configuration.default UpdatePublicKeyResponseupdatePublicKey(Consumer<UpdatePublicKeyRequest.Builder> updatePublicKeyRequest) Update public key information.default UpdatePublicKeyResponseupdatePublicKey(UpdatePublicKeyRequest updatePublicKeyRequest) Update public key information.default UpdateRealtimeLogConfigResponseupdateRealtimeLogConfig(Consumer<UpdateRealtimeLogConfigRequest.Builder> updateRealtimeLogConfigRequest) Updates a real-time log configuration.default UpdateRealtimeLogConfigResponseupdateRealtimeLogConfig(UpdateRealtimeLogConfigRequest updateRealtimeLogConfigRequest) Updates a real-time log configuration.updateResponseHeadersPolicy(Consumer<UpdateResponseHeadersPolicyRequest.Builder> updateResponseHeadersPolicyRequest) Updates a response headers policy.updateResponseHeadersPolicy(UpdateResponseHeadersPolicyRequest updateResponseHeadersPolicyRequest) Updates a response headers policy.updateStreamingDistribution(Consumer<UpdateStreamingDistributionRequest.Builder> updateStreamingDistributionRequest) Update a streaming distribution.updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest) Update a streaming distribution.default CloudFrontUtilitiesCreates an instance ofCloudFrontUtilitiesobject with the configuration set on this client.default CloudFrontWaiterwaiter()Create an instance ofCloudFrontWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
associateAlias
default AssociateAliasResponse associateAlias(AssociateAliasRequest associateAliasRequest) throws InvalidArgumentException, NoSuchDistributionException, TooManyDistributionCnamEsException, IllegalUpdateException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
- Parameters:
associateAliasRequest-- Returns:
- Result of the AssociateAlias operation returned by the service.
- See Also:
-
associateAlias
default AssociateAliasResponse associateAlias(Consumer<AssociateAliasRequest.Builder> associateAliasRequest) throws InvalidArgumentException, NoSuchDistributionException, TooManyDistributionCnamEsException, IllegalUpdateException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
AssociateAliasRequest.Builderavoiding the need to create one manually viaAssociateAliasRequest.builder()- Parameters:
associateAliasRequest- AConsumerthat will call methods onAssociateAliasRequest.Builderto create a request.- Returns:
- Result of the AssociateAlias operation returned by the service.
- See Also:
-
copyDistribution
default CopyDistributionResponse copyDistribution(CopyDistributionRequest copyDistributionRequest) throws CnameAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, InvalidIfMatchVersionException, NoSuchDistributionException, PreconditionFailedException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCnamEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, TooManyDistributionsAssociatedToOriginAccessControlException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, AwsServiceException, SdkClientException, CloudFrontException Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.
After you create a staging distribution, you can use
UpdateDistributionto modify the staging distribution's configuration. Then you can useCreateContinuousDeploymentPolicyto incrementally move traffic to the staging distribution.This API operation requires the following IAM permissions:
- Parameters:
copyDistributionRequest-- Returns:
- Result of the CopyDistribution operation returned by the service.
- See Also:
-
copyDistribution
default CopyDistributionResponse copyDistribution(Consumer<CopyDistributionRequest.Builder> copyDistributionRequest) throws CnameAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, InvalidIfMatchVersionException, NoSuchDistributionException, PreconditionFailedException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCnamEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, TooManyDistributionsAssociatedToOriginAccessControlException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, AwsServiceException, SdkClientException, CloudFrontException Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.
After you create a staging distribution, you can use
UpdateDistributionto modify the staging distribution's configuration. Then you can useCreateContinuousDeploymentPolicyto incrementally move traffic to the staging distribution.This API operation requires the following IAM permissions:
This is a convenience which creates an instance of the
CopyDistributionRequest.Builderavoiding the need to create one manually viaCopyDistributionRequest.builder()- Parameters:
copyDistributionRequest- AConsumerthat will call methods onCopyDistributionRequest.Builderto create a request.- Returns:
- Result of the CopyDistribution operation returned by the service.
- See Also:
-
createCachePolicy
default CreateCachePolicyResponse createCachePolicy(CreateCachePolicyRequest createCachePolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, CachePolicyAlreadyExistsException, TooManyCachePoliciesException, TooManyHeadersInCachePolicyException, TooManyCookiesInCachePolicyException, TooManyQueryStringsInCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the cache policy determines the following:
-
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
-
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use
OriginRequestPolicy.For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
- Parameters:
createCachePolicyRequest-- Returns:
- Result of the CreateCachePolicy operation returned by the service.
- See Also:
-
-
createCachePolicy
default CreateCachePolicyResponse createCachePolicy(Consumer<CreateCachePolicyRequest.Builder> createCachePolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, CachePolicyAlreadyExistsException, TooManyCachePoliciesException, TooManyHeadersInCachePolicyException, TooManyCookiesInCachePolicyException, TooManyQueryStringsInCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the cache policy determines the following:
-
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
-
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use
OriginRequestPolicy.For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
CreateCachePolicyRequest.Builderavoiding the need to create one manually viaCreateCachePolicyRequest.builder()- Parameters:
createCachePolicyRequest- AConsumerthat will call methods onCreateCachePolicyRequest.Builderto create a request.- Returns:
- Result of the CreateCachePolicy operation returned by the service.
- See Also:
-
-
createCloudFrontOriginAccessIdentity
default CreateCloudFrontOriginAccessIdentityResponse createCloudFrontOriginAccessIdentity(CreateCloudFrontOriginAccessIdentityRequest createCloudFrontOriginAccessIdentityRequest) throws CloudFrontOriginAccessIdentityAlreadyExistsException, MissingBodyException, TooManyCloudFrontOriginAccessIdentitiesException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
- Parameters:
createCloudFrontOriginAccessIdentityRequest- The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.- Returns:
- Result of the CreateCloudFrontOriginAccessIdentity operation returned by the service.
- See Also:
-
createCloudFrontOriginAccessIdentity
default CreateCloudFrontOriginAccessIdentityResponse createCloudFrontOriginAccessIdentity(Consumer<CreateCloudFrontOriginAccessIdentityRequest.Builder> createCloudFrontOriginAccessIdentityRequest) throws CloudFrontOriginAccessIdentityAlreadyExistsException, MissingBodyException, TooManyCloudFrontOriginAccessIdentitiesException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
CreateCloudFrontOriginAccessIdentityRequest.Builderavoiding the need to create one manually viaCreateCloudFrontOriginAccessIdentityRequest.builder()- Parameters:
createCloudFrontOriginAccessIdentityRequest- AConsumerthat will call methods onCreateCloudFrontOriginAccessIdentityRequest.Builderto create a request. The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.- Returns:
- Result of the CreateCloudFrontOriginAccessIdentity operation returned by the service.
- See Also:
-
createContinuousDeploymentPolicy
default CreateContinuousDeploymentPolicyResponse createContinuousDeploymentPolicy(CreateContinuousDeploymentPolicyRequest createContinuousDeploymentPolicyRequest) throws AccessDeniedException, InvalidArgumentException, InconsistentQuantitiesException, ContinuousDeploymentPolicyAlreadyExistsException, TooManyContinuousDeploymentPoliciesException, StagingDistributionInUseException, AwsServiceException, SdkClientException, CloudFrontException Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
To use a continuous deployment policy, first use
CopyDistributionto create a staging distribution, then useUpdateDistributionto modify the staging distribution's configuration.After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.
- Parameters:
createContinuousDeploymentPolicyRequest-- Returns:
- Result of the CreateContinuousDeploymentPolicy operation returned by the service.
- See Also:
-
createContinuousDeploymentPolicy
default CreateContinuousDeploymentPolicyResponse createContinuousDeploymentPolicy(Consumer<CreateContinuousDeploymentPolicyRequest.Builder> createContinuousDeploymentPolicyRequest) throws AccessDeniedException, InvalidArgumentException, InconsistentQuantitiesException, ContinuousDeploymentPolicyAlreadyExistsException, TooManyContinuousDeploymentPoliciesException, StagingDistributionInUseException, AwsServiceException, SdkClientException, CloudFrontException Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
To use a continuous deployment policy, first use
CopyDistributionto create a staging distribution, then useUpdateDistributionto modify the staging distribution's configuration.After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.
This is a convenience which creates an instance of the
CreateContinuousDeploymentPolicyRequest.Builderavoiding the need to create one manually viaCreateContinuousDeploymentPolicyRequest.builder()- Parameters:
createContinuousDeploymentPolicyRequest- AConsumerthat will call methods onCreateContinuousDeploymentPolicyRequest.Builderto create a request.- Returns:
- Result of the CreateContinuousDeploymentPolicy operation returned by the service.
- See Also:
-
createDistribution
default CreateDistributionResponse createDistribution(CreateDistributionRequest createDistributionRequest) throws CnameAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, IllegalOriginAccessConfigurationException, TooManyDistributionsAssociatedToOriginAccessControlException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCnamEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, ContinuousDeploymentPolicyInUseException, NoSuchContinuousDeploymentPolicyException, InvalidDomainNameForOriginAccessControlException, AwsServiceException, SdkClientException, CloudFrontException Creates a CloudFront distribution.
- Parameters:
createDistributionRequest- The request to create a new distribution.- Returns:
- Result of the CreateDistribution operation returned by the service.
- See Also:
-
createDistribution
default CreateDistributionResponse createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest) throws CnameAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, IllegalOriginAccessConfigurationException, TooManyDistributionsAssociatedToOriginAccessControlException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCnamEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, ContinuousDeploymentPolicyInUseException, NoSuchContinuousDeploymentPolicyException, InvalidDomainNameForOriginAccessControlException, AwsServiceException, SdkClientException, CloudFrontException Creates a CloudFront distribution.
This is a convenience which creates an instance of the
CreateDistributionRequest.Builderavoiding the need to create one manually viaCreateDistributionRequest.builder()- Parameters:
createDistributionRequest- AConsumerthat will call methods onCreateDistributionRequest.Builderto create a request. The request to create a new distribution.- Returns:
- Result of the CreateDistribution operation returned by the service.
- See Also:
-
createDistributionWithTags
default CreateDistributionWithTagsResponse createDistributionWithTags(CreateDistributionWithTagsRequest createDistributionWithTagsRequest) throws CnameAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, IllegalOriginAccessConfigurationException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCnamEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, InvalidTaggingException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, TooManyDistributionsAssociatedToOriginAccessControlException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, ContinuousDeploymentPolicyInUseException, NoSuchContinuousDeploymentPolicyException, InvalidDomainNameForOriginAccessControlException, AwsServiceException, SdkClientException, CloudFrontException Create a new distribution with tags. This API operation requires the following IAM permissions:
- Parameters:
createDistributionWithTagsRequest- The request to create a new distribution with tags.- Returns:
- Result of the CreateDistributionWithTags operation returned by the service.
- See Also:
-
createDistributionWithTags
default CreateDistributionWithTagsResponse createDistributionWithTags(Consumer<CreateDistributionWithTagsRequest.Builder> createDistributionWithTagsRequest) throws CnameAlreadyExistsException, DistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, IllegalOriginAccessConfigurationException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, MissingBodyException, TooManyDistributionCnamEsException, TooManyDistributionsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidProtocolSettingsException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, InvalidTaggingException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, TooManyDistributionsAssociatedToOriginAccessControlException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, ContinuousDeploymentPolicyInUseException, NoSuchContinuousDeploymentPolicyException, InvalidDomainNameForOriginAccessControlException, AwsServiceException, SdkClientException, CloudFrontException Create a new distribution with tags. This API operation requires the following IAM permissions:
This is a convenience which creates an instance of the
CreateDistributionWithTagsRequest.Builderavoiding the need to create one manually viaCreateDistributionWithTagsRequest.builder()- Parameters:
createDistributionWithTagsRequest- AConsumerthat will call methods onCreateDistributionWithTagsRequest.Builderto create a request. The request to create a new distribution with tags.- Returns:
- Result of the CreateDistributionWithTags operation returned by the service.
- See Also:
-
createFieldLevelEncryptionConfig
default CreateFieldLevelEncryptionConfigResponse createFieldLevelEncryptionConfig(CreateFieldLevelEncryptionConfigRequest createFieldLevelEncryptionConfigRequest) throws InconsistentQuantitiesException, InvalidArgumentException, NoSuchFieldLevelEncryptionProfileException, FieldLevelEncryptionConfigAlreadyExistsException, TooManyFieldLevelEncryptionConfigsException, TooManyFieldLevelEncryptionQueryArgProfilesException, TooManyFieldLevelEncryptionContentTypeProfilesException, QueryArgProfileEmptyException, AwsServiceException, SdkClientException, CloudFrontException Create a new field-level encryption configuration.
- Parameters:
createFieldLevelEncryptionConfigRequest-- Returns:
- Result of the CreateFieldLevelEncryptionConfig operation returned by the service.
- See Also:
-
createFieldLevelEncryptionConfig
default CreateFieldLevelEncryptionConfigResponse createFieldLevelEncryptionConfig(Consumer<CreateFieldLevelEncryptionConfigRequest.Builder> createFieldLevelEncryptionConfigRequest) throws InconsistentQuantitiesException, InvalidArgumentException, NoSuchFieldLevelEncryptionProfileException, FieldLevelEncryptionConfigAlreadyExistsException, TooManyFieldLevelEncryptionConfigsException, TooManyFieldLevelEncryptionQueryArgProfilesException, TooManyFieldLevelEncryptionContentTypeProfilesException, QueryArgProfileEmptyException, AwsServiceException, SdkClientException, CloudFrontException Create a new field-level encryption configuration.
This is a convenience which creates an instance of the
CreateFieldLevelEncryptionConfigRequest.Builderavoiding the need to create one manually viaCreateFieldLevelEncryptionConfigRequest.builder()- Parameters:
createFieldLevelEncryptionConfigRequest- AConsumerthat will call methods onCreateFieldLevelEncryptionConfigRequest.Builderto create a request.- Returns:
- Result of the CreateFieldLevelEncryptionConfig operation returned by the service.
- See Also:
-
createFieldLevelEncryptionProfile
default CreateFieldLevelEncryptionProfileResponse createFieldLevelEncryptionProfile(CreateFieldLevelEncryptionProfileRequest createFieldLevelEncryptionProfileRequest) throws InconsistentQuantitiesException, InvalidArgumentException, NoSuchPublicKeyException, FieldLevelEncryptionProfileAlreadyExistsException, FieldLevelEncryptionProfileSizeExceededException, TooManyFieldLevelEncryptionProfilesException, TooManyFieldLevelEncryptionEncryptionEntitiesException, TooManyFieldLevelEncryptionFieldPatternsException, AwsServiceException, SdkClientException, CloudFrontException Create a field-level encryption profile.
- Parameters:
createFieldLevelEncryptionProfileRequest-- Returns:
- Result of the CreateFieldLevelEncryptionProfile operation returned by the service.
- See Also:
-
createFieldLevelEncryptionProfile
default CreateFieldLevelEncryptionProfileResponse createFieldLevelEncryptionProfile(Consumer<CreateFieldLevelEncryptionProfileRequest.Builder> createFieldLevelEncryptionProfileRequest) throws InconsistentQuantitiesException, InvalidArgumentException, NoSuchPublicKeyException, FieldLevelEncryptionProfileAlreadyExistsException, FieldLevelEncryptionProfileSizeExceededException, TooManyFieldLevelEncryptionProfilesException, TooManyFieldLevelEncryptionEncryptionEntitiesException, TooManyFieldLevelEncryptionFieldPatternsException, AwsServiceException, SdkClientException, CloudFrontException Create a field-level encryption profile.
This is a convenience which creates an instance of the
CreateFieldLevelEncryptionProfileRequest.Builderavoiding the need to create one manually viaCreateFieldLevelEncryptionProfileRequest.builder()- Parameters:
createFieldLevelEncryptionProfileRequest- AConsumerthat will call methods onCreateFieldLevelEncryptionProfileRequest.Builderto create a request.- Returns:
- Result of the CreateFieldLevelEncryptionProfile operation returned by the service.
- See Also:
-
createFunction
default CreateFunctionResponse createFunction(CreateFunctionRequest createFunctionRequest) throws TooManyFunctionsException, FunctionAlreadyExistsException, FunctionSizeLimitExceededException, InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it's in the
DEVELOPMENTstage. In this stage, you can test the function withTestFunction, and update it withUpdateFunction.When you're ready to use your function with a CloudFront distribution, use
PublishFunctionto copy the function from theDEVELOPMENTstage toLIVE. When it's live, you can attach the function to a distribution's cache behavior, using the function's ARN.- Parameters:
createFunctionRequest-- Returns:
- Result of the CreateFunction operation returned by the service.
- See Also:
-
createFunction
default CreateFunctionResponse createFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest) throws TooManyFunctionsException, FunctionAlreadyExistsException, FunctionSizeLimitExceededException, InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it's in the
DEVELOPMENTstage. In this stage, you can test the function withTestFunction, and update it withUpdateFunction.When you're ready to use your function with a CloudFront distribution, use
PublishFunctionto copy the function from theDEVELOPMENTstage toLIVE. When it's live, you can attach the function to a distribution's cache behavior, using the function's ARN.
This is a convenience which creates an instance of the
CreateFunctionRequest.Builderavoiding the need to create one manually viaCreateFunctionRequest.builder()- Parameters:
createFunctionRequest- AConsumerthat will call methods onCreateFunctionRequest.Builderto create a request.- Returns:
- Result of the CreateFunction operation returned by the service.
- See Also:
-
createInvalidation
default CreateInvalidationResponse createInvalidation(CreateInvalidationRequest createInvalidationRequest) throws AccessDeniedException, MissingBodyException, InvalidArgumentException, NoSuchDistributionException, BatchTooLargeException, TooManyInvalidationsInProgressException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
- Parameters:
createInvalidationRequest- The request to create an invalidation.- Returns:
- Result of the CreateInvalidation operation returned by the service.
- See Also:
-
createInvalidation
default CreateInvalidationResponse createInvalidation(Consumer<CreateInvalidationRequest.Builder> createInvalidationRequest) throws AccessDeniedException, MissingBodyException, InvalidArgumentException, NoSuchDistributionException, BatchTooLargeException, TooManyInvalidationsInProgressException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
CreateInvalidationRequest.Builderavoiding the need to create one manually viaCreateInvalidationRequest.builder()- Parameters:
createInvalidationRequest- AConsumerthat will call methods onCreateInvalidationRequest.Builderto create a request. The request to create an invalidation.- Returns:
- Result of the CreateInvalidation operation returned by the service.
- See Also:
-
createKeyGroup
default CreateKeyGroupResponse createKeyGroup(CreateKeyGroupRequest createKeyGroupRequest) throws InvalidArgumentException, KeyGroupAlreadyExistsException, TooManyKeyGroupsException, TooManyPublicKeysInKeyGroupException, AwsServiceException, SdkClientException, CloudFrontException Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
- Parameters:
createKeyGroupRequest-- Returns:
- Result of the CreateKeyGroup operation returned by the service.
- See Also:
-
createKeyGroup
default CreateKeyGroupResponse createKeyGroup(Consumer<CreateKeyGroupRequest.Builder> createKeyGroupRequest) throws InvalidArgumentException, KeyGroupAlreadyExistsException, TooManyKeyGroupsException, TooManyPublicKeysInKeyGroupException, AwsServiceException, SdkClientException, CloudFrontException Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
CreateKeyGroupRequest.Builderavoiding the need to create one manually viaCreateKeyGroupRequest.builder()- Parameters:
createKeyGroupRequest- AConsumerthat will call methods onCreateKeyGroupRequest.Builderto create a request.- Returns:
- Result of the CreateKeyGroup operation returned by the service.
- See Also:
-
createKeyValueStore
default CreateKeyValueStoreResponse createKeyValueStore(CreateKeyValueStoreRequest createKeyValueStoreRequest) throws AccessDeniedException, EntityLimitExceededException, EntityAlreadyExistsException, EntitySizeLimitExceededException, InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid
ImportSourcethat you own.- Parameters:
createKeyValueStoreRequest-- Returns:
- Result of the CreateKeyValueStore operation returned by the service.
- See Also:
-
createKeyValueStore
default CreateKeyValueStoreResponse createKeyValueStore(Consumer<CreateKeyValueStoreRequest.Builder> createKeyValueStoreRequest) throws AccessDeniedException, EntityLimitExceededException, EntityAlreadyExistsException, EntitySizeLimitExceededException, InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid
ImportSourcethat you own.
This is a convenience which creates an instance of the
CreateKeyValueStoreRequest.Builderavoiding the need to create one manually viaCreateKeyValueStoreRequest.builder()- Parameters:
createKeyValueStoreRequest- AConsumerthat will call methods onCreateKeyValueStoreRequest.Builderto create a request.- Returns:
- Result of the CreateKeyValueStore operation returned by the service.
- See Also:
-
createMonitoringSubscription
default CreateMonitoringSubscriptionResponse createMonitoringSubscription(CreateMonitoringSubscriptionRequest createMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, MonitoringSubscriptionAlreadyExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
- Parameters:
createMonitoringSubscriptionRequest-- Returns:
- Result of the CreateMonitoringSubscription operation returned by the service.
- See Also:
-
createMonitoringSubscription
default CreateMonitoringSubscriptionResponse createMonitoringSubscription(Consumer<CreateMonitoringSubscriptionRequest.Builder> createMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, MonitoringSubscriptionAlreadyExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
CreateMonitoringSubscriptionRequest.Builderavoiding the need to create one manually viaCreateMonitoringSubscriptionRequest.builder()- Parameters:
createMonitoringSubscriptionRequest- AConsumerthat will call methods onCreateMonitoringSubscriptionRequest.Builderto create a request.- Returns:
- Result of the CreateMonitoringSubscription operation returned by the service.
- See Also:
-
createOriginAccessControl
default CreateOriginAccessControlResponse createOriginAccessControl(CreateOriginAccessControlRequest createOriginAccessControlRequest) throws OriginAccessControlAlreadyExistsException, TooManyOriginAccessControlsException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the Amazon CloudFront Developer Guide.
- Parameters:
createOriginAccessControlRequest-- Returns:
- Result of the CreateOriginAccessControl operation returned by the service.
- See Also:
-
createOriginAccessControl
default CreateOriginAccessControlResponse createOriginAccessControl(Consumer<CreateOriginAccessControlRequest.Builder> createOriginAccessControlRequest) throws OriginAccessControlAlreadyExistsException, TooManyOriginAccessControlsException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
CreateOriginAccessControlRequest.Builderavoiding the need to create one manually viaCreateOriginAccessControlRequest.builder()- Parameters:
createOriginAccessControlRequest- AConsumerthat will call methods onCreateOriginAccessControlRequest.Builderto create a request.- Returns:
- Result of the CreateOriginAccessControl operation returned by the service.
- See Also:
-
createOriginRequestPolicy
default CreateOriginRequestPolicyResponse createOriginRequestPolicy(CreateOriginRequestPolicyRequest createOriginRequestPolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, OriginRequestPolicyAlreadyExistsException, TooManyOriginRequestPoliciesException, TooManyHeadersInOriginRequestPolicyException, TooManyCookiesInOriginRequestPolicyException, TooManyQueryStringsInOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
-
The request body and the URL path (without the domain name) from the viewer request.
-
The headers that CloudFront automatically includes in every origin request, including
Host,User-Agent, andX-Amz-Cf-Id. -
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can't find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use
CachePolicy.For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
- Parameters:
createOriginRequestPolicyRequest-- Returns:
- Result of the CreateOriginRequestPolicy operation returned by the service.
- See Also:
-
-
createOriginRequestPolicy
default CreateOriginRequestPolicyResponse createOriginRequestPolicy(Consumer<CreateOriginRequestPolicyRequest.Builder> createOriginRequestPolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, OriginRequestPolicyAlreadyExistsException, TooManyOriginRequestPoliciesException, TooManyHeadersInOriginRequestPolicyException, TooManyCookiesInOriginRequestPolicyException, TooManyQueryStringsInOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
-
The request body and the URL path (without the domain name) from the viewer request.
-
The headers that CloudFront automatically includes in every origin request, including
Host,User-Agent, andX-Amz-Cf-Id. -
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can't find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use
CachePolicy.For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
CreateOriginRequestPolicyRequest.Builderavoiding the need to create one manually viaCreateOriginRequestPolicyRequest.builder()- Parameters:
createOriginRequestPolicyRequest- AConsumerthat will call methods onCreateOriginRequestPolicyRequest.Builderto create a request.- Returns:
- Result of the CreateOriginRequestPolicy operation returned by the service.
- See Also:
-
-
createPublicKey
default CreatePublicKeyResponse createPublicKey(CreatePublicKeyRequest createPublicKeyRequest) throws PublicKeyAlreadyExistsException, InvalidArgumentException, TooManyPublicKeysException, AwsServiceException, SdkClientException, CloudFrontException Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
- Parameters:
createPublicKeyRequest-- Returns:
- Result of the CreatePublicKey operation returned by the service.
- See Also:
-
createPublicKey
default CreatePublicKeyResponse createPublicKey(Consumer<CreatePublicKeyRequest.Builder> createPublicKeyRequest) throws PublicKeyAlreadyExistsException, InvalidArgumentException, TooManyPublicKeysException, AwsServiceException, SdkClientException, CloudFrontException Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
This is a convenience which creates an instance of the
CreatePublicKeyRequest.Builderavoiding the need to create one manually viaCreatePublicKeyRequest.builder()- Parameters:
createPublicKeyRequest- AConsumerthat will call methods onCreatePublicKeyRequest.Builderto create a request.- Returns:
- Result of the CreatePublicKey operation returned by the service.
- See Also:
-
createRealtimeLogConfig
default CreateRealtimeLogConfigResponse createRealtimeLogConfig(CreateRealtimeLogConfigRequest createRealtimeLogConfigRequest) throws RealtimeLogConfigAlreadyExistsException, TooManyRealtimeLogConfigsException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
- Parameters:
createRealtimeLogConfigRequest-- Returns:
- Result of the CreateRealtimeLogConfig operation returned by the service.
- See Also:
-
createRealtimeLogConfig
default CreateRealtimeLogConfigResponse createRealtimeLogConfig(Consumer<CreateRealtimeLogConfigRequest.Builder> createRealtimeLogConfigRequest) throws RealtimeLogConfigAlreadyExistsException, TooManyRealtimeLogConfigsException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
CreateRealtimeLogConfigRequest.Builderavoiding the need to create one manually viaCreateRealtimeLogConfigRequest.builder()- Parameters:
createRealtimeLogConfigRequest- AConsumerthat will call methods onCreateRealtimeLogConfigRequest.Builderto create a request.- Returns:
- Result of the CreateRealtimeLogConfig operation returned by the service.
- See Also:
-
createResponseHeadersPolicy
default CreateResponseHeadersPolicyResponse createResponseHeadersPolicy(CreateResponseHeadersPolicyRequest createResponseHeadersPolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, ResponseHeadersPolicyAlreadyExistsException, TooManyResponseHeadersPoliciesException, TooManyCustomHeadersInResponseHeadersPolicyException, TooLongCspInResponseHeadersPolicyException, TooManyRemoveHeadersInResponseHeadersPolicyException, AwsServiceException, SdkClientException, CloudFrontException Creates a response headers policy.
A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
- Parameters:
createResponseHeadersPolicyRequest-- Returns:
- Result of the CreateResponseHeadersPolicy operation returned by the service.
- See Also:
-
createResponseHeadersPolicy
default CreateResponseHeadersPolicyResponse createResponseHeadersPolicy(Consumer<CreateResponseHeadersPolicyRequest.Builder> createResponseHeadersPolicyRequest) throws AccessDeniedException, InconsistentQuantitiesException, InvalidArgumentException, ResponseHeadersPolicyAlreadyExistsException, TooManyResponseHeadersPoliciesException, TooManyCustomHeadersInResponseHeadersPolicyException, TooLongCspInResponseHeadersPolicyException, TooManyRemoveHeadersInResponseHeadersPolicyException, AwsServiceException, SdkClientException, CloudFrontException Creates a response headers policy.
A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
CreateResponseHeadersPolicyRequest.Builderavoiding the need to create one manually viaCreateResponseHeadersPolicyRequest.builder()- Parameters:
createResponseHeadersPolicyRequest- AConsumerthat will call methods onCreateResponseHeadersPolicyRequest.Builderto create a request.- Returns:
- Result of the CreateResponseHeadersPolicy operation returned by the service.
- See Also:
-
createStreamingDistribution
default CreateStreamingDistributionResponse createStreamingDistribution(CreateStreamingDistributionRequest createStreamingDistributionRequest) throws CnameAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCnamEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
- Parameters:
createStreamingDistributionRequest- The request to create a new streaming distribution.- Returns:
- Result of the CreateStreamingDistribution operation returned by the service.
- See Also:
-
createStreamingDistribution
default CreateStreamingDistributionResponse createStreamingDistribution(Consumer<CreateStreamingDistributionRequest.Builder> createStreamingDistributionRequest) throws CnameAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCnamEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
This is a convenience which creates an instance of the
CreateStreamingDistributionRequest.Builderavoiding the need to create one manually viaCreateStreamingDistributionRequest.builder()- Parameters:
createStreamingDistributionRequest- AConsumerthat will call methods onCreateStreamingDistributionRequest.Builderto create a request. The request to create a new streaming distribution.- Returns:
- Result of the CreateStreamingDistribution operation returned by the service.
- See Also:
-
createStreamingDistributionWithTags
default CreateStreamingDistributionWithTagsResponse createStreamingDistributionWithTags(CreateStreamingDistributionWithTagsRequest createStreamingDistributionWithTagsRequest) throws CnameAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCnamEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, InvalidTaggingException, AwsServiceException, SdkClientException, CloudFrontException This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
- Parameters:
createStreamingDistributionWithTagsRequest- The request to create a new streaming distribution with tags.- Returns:
- Result of the CreateStreamingDistributionWithTags operation returned by the service.
- See Also:
-
createStreamingDistributionWithTags
default CreateStreamingDistributionWithTagsResponse createStreamingDistributionWithTags(Consumer<CreateStreamingDistributionWithTagsRequest.Builder> createStreamingDistributionWithTagsRequest) throws CnameAlreadyExistsException, StreamingDistributionAlreadyExistsException, InvalidOriginException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, AccessDeniedException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, MissingBodyException, TooManyStreamingDistributionCnamEsException, TooManyStreamingDistributionsException, InvalidArgumentException, InconsistentQuantitiesException, InvalidTaggingException, AwsServiceException, SdkClientException, CloudFrontException This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
This is a convenience which creates an instance of the
CreateStreamingDistributionWithTagsRequest.Builderavoiding the need to create one manually viaCreateStreamingDistributionWithTagsRequest.builder()- Parameters:
createStreamingDistributionWithTagsRequest- AConsumerthat will call methods onCreateStreamingDistributionWithTagsRequest.Builderto create a request. The request to create a new streaming distribution with tags.- Returns:
- Result of the CreateStreamingDistributionWithTags operation returned by the service.
- See Also:
-
deleteCachePolicy
default DeleteCachePolicyResponse deleteCachePolicy(DeleteCachePolicyRequest deleteCachePolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchCachePolicyException, PreconditionFailedException, IllegalDeleteException, CachePolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes a cache policy.
You cannot delete a cache policy if it's attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy's identifier and version. To get these values, you can use
ListCachePoliciesorGetCachePolicy.- Parameters:
deleteCachePolicyRequest-- Returns:
- Result of the DeleteCachePolicy operation returned by the service.
- See Also:
-
deleteCachePolicy
default DeleteCachePolicyResponse deleteCachePolicy(Consumer<DeleteCachePolicyRequest.Builder> deleteCachePolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchCachePolicyException, PreconditionFailedException, IllegalDeleteException, CachePolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes a cache policy.
You cannot delete a cache policy if it's attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy's identifier and version. To get these values, you can use
ListCachePoliciesorGetCachePolicy.
This is a convenience which creates an instance of the
DeleteCachePolicyRequest.Builderavoiding the need to create one manually viaDeleteCachePolicyRequest.builder()- Parameters:
deleteCachePolicyRequest- AConsumerthat will call methods onDeleteCachePolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteCachePolicy operation returned by the service.
- See Also:
-
deleteCloudFrontOriginAccessIdentity
default DeleteCloudFrontOriginAccessIdentityResponse deleteCloudFrontOriginAccessIdentity(DeleteCloudFrontOriginAccessIdentityRequest deleteCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, CloudFrontOriginAccessIdentityInUseException, AwsServiceException, SdkClientException, CloudFrontException Delete an origin access identity.
- Parameters:
deleteCloudFrontOriginAccessIdentityRequest- Deletes a origin access identity.- Returns:
- Result of the DeleteCloudFrontOriginAccessIdentity operation returned by the service.
- See Also:
-
deleteCloudFrontOriginAccessIdentity
default DeleteCloudFrontOriginAccessIdentityResponse deleteCloudFrontOriginAccessIdentity(Consumer<DeleteCloudFrontOriginAccessIdentityRequest.Builder> deleteCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, CloudFrontOriginAccessIdentityInUseException, AwsServiceException, SdkClientException, CloudFrontException Delete an origin access identity.
This is a convenience which creates an instance of the
DeleteCloudFrontOriginAccessIdentityRequest.Builderavoiding the need to create one manually viaDeleteCloudFrontOriginAccessIdentityRequest.builder()- Parameters:
deleteCloudFrontOriginAccessIdentityRequest- AConsumerthat will call methods onDeleteCloudFrontOriginAccessIdentityRequest.Builderto create a request. Deletes a origin access identity.- Returns:
- Result of the DeleteCloudFrontOriginAccessIdentity operation returned by the service.
- See Also:
-
deleteContinuousDeploymentPolicy
default DeleteContinuousDeploymentPolicyResponse deleteContinuousDeploymentPolicy(DeleteContinuousDeploymentPolicyRequest deleteContinuousDeploymentPolicyRequest) throws InvalidIfMatchVersionException, InvalidArgumentException, AccessDeniedException, PreconditionFailedException, ContinuousDeploymentPolicyInUseException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Deletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.
- Parameters:
deleteContinuousDeploymentPolicyRequest-- Returns:
- Result of the DeleteContinuousDeploymentPolicy operation returned by the service.
- See Also:
-
deleteContinuousDeploymentPolicy
default DeleteContinuousDeploymentPolicyResponse deleteContinuousDeploymentPolicy(Consumer<DeleteContinuousDeploymentPolicyRequest.Builder> deleteContinuousDeploymentPolicyRequest) throws InvalidIfMatchVersionException, InvalidArgumentException, AccessDeniedException, PreconditionFailedException, ContinuousDeploymentPolicyInUseException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Deletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.
This is a convenience which creates an instance of the
DeleteContinuousDeploymentPolicyRequest.Builderavoiding the need to create one manually viaDeleteContinuousDeploymentPolicyRequest.builder()- Parameters:
deleteContinuousDeploymentPolicyRequest- AConsumerthat will call methods onDeleteContinuousDeploymentPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteContinuousDeploymentPolicy operation returned by the service.
- See Also:
-
deleteDistribution
default DeleteDistributionResponse deleteDistribution(DeleteDistributionRequest deleteDistributionRequest) throws AccessDeniedException, DistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchDistributionException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException Delete a distribution.
- Parameters:
deleteDistributionRequest- This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.To delete a web distribution using the CloudFront API:
-
Disable the web distribution
-
Submit a
GET Distribution Configrequest to get the current configuration and theEtagheader for the distribution. -
Update the XML document that was returned in the response to your
GET Distribution Configrequest to change the value ofEnabledtofalse. -
Submit a
PUT Distribution Configrequest to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Distribution Configrequest in Step 2. -
Review the response to the
PUT Distribution Configrequest to confirm that the distribution was successfully disabled. -
Submit a
GET Distributionrequest to confirm that your changes have propagated. When propagation is complete, the value ofStatusisDeployed. -
Submit a
DELETE Distributionrequest. Set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Distribution Configrequest in Step 6. -
Review the response to your
DELETE Distributionrequest to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
-
- Returns:
- Result of the DeleteDistribution operation returned by the service.
- See Also:
-
deleteDistribution
default DeleteDistributionResponse deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest) throws AccessDeniedException, DistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchDistributionException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException Delete a distribution.
This is a convenience which creates an instance of the
DeleteDistributionRequest.Builderavoiding the need to create one manually viaDeleteDistributionRequest.builder()- Parameters:
deleteDistributionRequest- AConsumerthat will call methods onDeleteDistributionRequest.Builderto create a request. This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.To delete a web distribution using the CloudFront API:
-
Disable the web distribution
-
Submit a
GET Distribution Configrequest to get the current configuration and theEtagheader for the distribution. -
Update the XML document that was returned in the response to your
GET Distribution Configrequest to change the value ofEnabledtofalse. -
Submit a
PUT Distribution Configrequest to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Distribution Configrequest in Step 2. -
Review the response to the
PUT Distribution Configrequest to confirm that the distribution was successfully disabled. -
Submit a
GET Distributionrequest to confirm that your changes have propagated. When propagation is complete, the value ofStatusisDeployed. -
Submit a
DELETE Distributionrequest. Set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Distribution Configrequest in Step 6. -
Review the response to your
DELETE Distributionrequest to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
-
- Returns:
- Result of the DeleteDistribution operation returned by the service.
- See Also:
-
deleteFieldLevelEncryptionConfig
default DeleteFieldLevelEncryptionConfigResponse deleteFieldLevelEncryptionConfig(DeleteFieldLevelEncryptionConfigRequest deleteFieldLevelEncryptionConfigRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionConfigException, PreconditionFailedException, FieldLevelEncryptionConfigInUseException, AwsServiceException, SdkClientException, CloudFrontException Remove a field-level encryption configuration.
- Parameters:
deleteFieldLevelEncryptionConfigRequest-- Returns:
- Result of the DeleteFieldLevelEncryptionConfig operation returned by the service.
- See Also:
-
deleteFieldLevelEncryptionConfig
default DeleteFieldLevelEncryptionConfigResponse deleteFieldLevelEncryptionConfig(Consumer<DeleteFieldLevelEncryptionConfigRequest.Builder> deleteFieldLevelEncryptionConfigRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionConfigException, PreconditionFailedException, FieldLevelEncryptionConfigInUseException, AwsServiceException, SdkClientException, CloudFrontException Remove a field-level encryption configuration.
This is a convenience which creates an instance of the
DeleteFieldLevelEncryptionConfigRequest.Builderavoiding the need to create one manually viaDeleteFieldLevelEncryptionConfigRequest.builder()- Parameters:
deleteFieldLevelEncryptionConfigRequest- AConsumerthat will call methods onDeleteFieldLevelEncryptionConfigRequest.Builderto create a request.- Returns:
- Result of the DeleteFieldLevelEncryptionConfig operation returned by the service.
- See Also:
-
deleteFieldLevelEncryptionProfile
default DeleteFieldLevelEncryptionProfileResponse deleteFieldLevelEncryptionProfile(DeleteFieldLevelEncryptionProfileRequest deleteFieldLevelEncryptionProfileRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionProfileException, PreconditionFailedException, FieldLevelEncryptionProfileInUseException, AwsServiceException, SdkClientException, CloudFrontException Remove a field-level encryption profile.
- Parameters:
deleteFieldLevelEncryptionProfileRequest-- Returns:
- Result of the DeleteFieldLevelEncryptionProfile operation returned by the service.
- See Also:
-
deleteFieldLevelEncryptionProfile
default DeleteFieldLevelEncryptionProfileResponse deleteFieldLevelEncryptionProfile(Consumer<DeleteFieldLevelEncryptionProfileRequest.Builder> deleteFieldLevelEncryptionProfileRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionProfileException, PreconditionFailedException, FieldLevelEncryptionProfileInUseException, AwsServiceException, SdkClientException, CloudFrontException Remove a field-level encryption profile.
This is a convenience which creates an instance of the
DeleteFieldLevelEncryptionProfileRequest.Builderavoiding the need to create one manually viaDeleteFieldLevelEncryptionProfileRequest.builder()- Parameters:
deleteFieldLevelEncryptionProfileRequest- AConsumerthat will call methods onDeleteFieldLevelEncryptionProfileRequest.Builderto create a request.- Returns:
- Result of the DeleteFieldLevelEncryptionProfile operation returned by the service.
- See Also:
-
deleteFunction
default DeleteFunctionResponse deleteFunction(DeleteFunctionRequest deleteFunctionRequest) throws InvalidIfMatchVersionException, NoSuchFunctionExistsException, FunctionInUseException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Deletes a CloudFront function.
You cannot delete a function if it's associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function's name and version (
ETagvalue). To get these values, you can useListFunctionsandDescribeFunction.- Parameters:
deleteFunctionRequest-- Returns:
- Result of the DeleteFunction operation returned by the service.
- See Also:
-
deleteFunction
default DeleteFunctionResponse deleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest) throws InvalidIfMatchVersionException, NoSuchFunctionExistsException, FunctionInUseException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Deletes a CloudFront function.
You cannot delete a function if it's associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function's name and version (
ETagvalue). To get these values, you can useListFunctionsandDescribeFunction.
This is a convenience which creates an instance of the
DeleteFunctionRequest.Builderavoiding the need to create one manually viaDeleteFunctionRequest.builder()- Parameters:
deleteFunctionRequest- AConsumerthat will call methods onDeleteFunctionRequest.Builderto create a request.- Returns:
- Result of the DeleteFunction operation returned by the service.
- See Also:
-
deleteKeyGroup
default DeleteKeyGroupResponse deleteKeyGroup(DeleteKeyGroupRequest deleteKeyGroupRequest) throws InvalidIfMatchVersionException, NoSuchResourceException, PreconditionFailedException, ResourceInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group's identifier and version. To get these values, use
ListKeyGroupsfollowed byGetKeyGrouporGetKeyGroupConfig.- Parameters:
deleteKeyGroupRequest-- Returns:
- Result of the DeleteKeyGroup operation returned by the service.
- See Also:
-
deleteKeyGroup
default DeleteKeyGroupResponse deleteKeyGroup(Consumer<DeleteKeyGroupRequest.Builder> deleteKeyGroupRequest) throws InvalidIfMatchVersionException, NoSuchResourceException, PreconditionFailedException, ResourceInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group's identifier and version. To get these values, use
ListKeyGroupsfollowed byGetKeyGrouporGetKeyGroupConfig.
This is a convenience which creates an instance of the
DeleteKeyGroupRequest.Builderavoiding the need to create one manually viaDeleteKeyGroupRequest.builder()- Parameters:
deleteKeyGroupRequest- AConsumerthat will call methods onDeleteKeyGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteKeyGroup operation returned by the service.
- See Also:
-
deleteKeyValueStore
default DeleteKeyValueStoreResponse deleteKeyValueStore(DeleteKeyValueStoreRequest deleteKeyValueStoreRequest) throws AccessDeniedException, InvalidIfMatchVersionException, EntityNotFoundException, CannotDeleteEntityWhileInUseException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value store to delete.
- Parameters:
deleteKeyValueStoreRequest-- Returns:
- Result of the DeleteKeyValueStore operation returned by the service.
- See Also:
-
deleteKeyValueStore
default DeleteKeyValueStoreResponse deleteKeyValueStore(Consumer<DeleteKeyValueStoreRequest.Builder> deleteKeyValueStoreRequest) throws AccessDeniedException, InvalidIfMatchVersionException, EntityNotFoundException, CannotDeleteEntityWhileInUseException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value store to delete.
This is a convenience which creates an instance of the
DeleteKeyValueStoreRequest.Builderavoiding the need to create one manually viaDeleteKeyValueStoreRequest.builder()- Parameters:
deleteKeyValueStoreRequest- AConsumerthat will call methods onDeleteKeyValueStoreRequest.Builderto create a request.- Returns:
- Result of the DeleteKeyValueStore operation returned by the service.
- See Also:
-
deleteMonitoringSubscription
default DeleteMonitoringSubscriptionResponse deleteMonitoringSubscription(DeleteMonitoringSubscriptionRequest deleteMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, NoSuchMonitoringSubscriptionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Disables additional CloudWatch metrics for the specified CloudFront distribution.
- Parameters:
deleteMonitoringSubscriptionRequest-- Returns:
- Result of the DeleteMonitoringSubscription operation returned by the service.
- See Also:
-
deleteMonitoringSubscription
default DeleteMonitoringSubscriptionResponse deleteMonitoringSubscription(Consumer<DeleteMonitoringSubscriptionRequest.Builder> deleteMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, NoSuchMonitoringSubscriptionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Disables additional CloudWatch metrics for the specified CloudFront distribution.
This is a convenience which creates an instance of the
DeleteMonitoringSubscriptionRequest.Builderavoiding the need to create one manually viaDeleteMonitoringSubscriptionRequest.builder()- Parameters:
deleteMonitoringSubscriptionRequest- AConsumerthat will call methods onDeleteMonitoringSubscriptionRequest.Builderto create a request.- Returns:
- Result of the DeleteMonitoringSubscription operation returned by the service.
- See Also:
-
deleteOriginAccessControl
default DeleteOriginAccessControlResponse deleteOriginAccessControl(DeleteOriginAccessControlRequest deleteOriginAccessControlRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchOriginAccessControlException, PreconditionFailedException, OriginAccessControlInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.
- Parameters:
deleteOriginAccessControlRequest-- Returns:
- Result of the DeleteOriginAccessControl operation returned by the service.
- See Also:
-
deleteOriginAccessControl
default DeleteOriginAccessControlResponse deleteOriginAccessControl(Consumer<DeleteOriginAccessControlRequest.Builder> deleteOriginAccessControlRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchOriginAccessControlException, PreconditionFailedException, OriginAccessControlInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.
This is a convenience which creates an instance of the
DeleteOriginAccessControlRequest.Builderavoiding the need to create one manually viaDeleteOriginAccessControlRequest.builder()- Parameters:
deleteOriginAccessControlRequest- AConsumerthat will call methods onDeleteOriginAccessControlRequest.Builderto create a request.- Returns:
- Result of the DeleteOriginAccessControl operation returned by the service.
- See Also:
-
deleteOriginRequestPolicy
default DeleteOriginRequestPolicyResponse deleteOriginRequestPolicy(DeleteOriginRequestPolicyRequest deleteOriginRequestPolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchOriginRequestPolicyException, PreconditionFailedException, IllegalDeleteException, OriginRequestPolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes an origin request policy.
You cannot delete an origin request policy if it's attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy's identifier and version. To get the identifier, you can use
ListOriginRequestPoliciesorGetOriginRequestPolicy.- Parameters:
deleteOriginRequestPolicyRequest-- Returns:
- Result of the DeleteOriginRequestPolicy operation returned by the service.
- See Also:
-
deleteOriginRequestPolicy
default DeleteOriginRequestPolicyResponse deleteOriginRequestPolicy(Consumer<DeleteOriginRequestPolicyRequest.Builder> deleteOriginRequestPolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchOriginRequestPolicyException, PreconditionFailedException, IllegalDeleteException, OriginRequestPolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes an origin request policy.
You cannot delete an origin request policy if it's attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy's identifier and version. To get the identifier, you can use
ListOriginRequestPoliciesorGetOriginRequestPolicy.
This is a convenience which creates an instance of the
DeleteOriginRequestPolicyRequest.Builderavoiding the need to create one manually viaDeleteOriginRequestPolicyRequest.builder()- Parameters:
deleteOriginRequestPolicyRequest- AConsumerthat will call methods onDeleteOriginRequestPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteOriginRequestPolicy operation returned by the service.
- See Also:
-
deletePublicKey
default DeletePublicKeyResponse deletePublicKey(DeletePublicKeyRequest deletePublicKeyRequest) throws AccessDeniedException, PublicKeyInUseException, InvalidIfMatchVersionException, NoSuchPublicKeyException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException Remove a public key you previously added to CloudFront.
- Parameters:
deletePublicKeyRequest-- Returns:
- Result of the DeletePublicKey operation returned by the service.
- See Also:
-
deletePublicKey
default DeletePublicKeyResponse deletePublicKey(Consumer<DeletePublicKeyRequest.Builder> deletePublicKeyRequest) throws AccessDeniedException, PublicKeyInUseException, InvalidIfMatchVersionException, NoSuchPublicKeyException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException Remove a public key you previously added to CloudFront.
This is a convenience which creates an instance of the
DeletePublicKeyRequest.Builderavoiding the need to create one manually viaDeletePublicKeyRequest.builder()- Parameters:
deletePublicKeyRequest- AConsumerthat will call methods onDeletePublicKeyRequest.Builderto create a request.- Returns:
- Result of the DeletePublicKey operation returned by the service.
- See Also:
-
deleteRealtimeLogConfig
default DeleteRealtimeLogConfigResponse deleteRealtimeLogConfig(DeleteRealtimeLogConfigRequest deleteRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, RealtimeLogConfigInUseException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it's attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
- Parameters:
deleteRealtimeLogConfigRequest-- Returns:
- Result of the DeleteRealtimeLogConfig operation returned by the service.
- See Also:
-
deleteRealtimeLogConfig
default DeleteRealtimeLogConfigResponse deleteRealtimeLogConfig(Consumer<DeleteRealtimeLogConfigRequest.Builder> deleteRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, RealtimeLogConfigInUseException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it's attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
This is a convenience which creates an instance of the
DeleteRealtimeLogConfigRequest.Builderavoiding the need to create one manually viaDeleteRealtimeLogConfigRequest.builder()- Parameters:
deleteRealtimeLogConfigRequest- AConsumerthat will call methods onDeleteRealtimeLogConfigRequest.Builderto create a request.- Returns:
- Result of the DeleteRealtimeLogConfig operation returned by the service.
- See Also:
-
deleteResponseHeadersPolicy
default DeleteResponseHeadersPolicyResponse deleteResponseHeadersPolicy(DeleteResponseHeadersPolicyRequest deleteResponseHeadersPolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchResponseHeadersPolicyException, PreconditionFailedException, IllegalDeleteException, ResponseHeadersPolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes a response headers policy.
You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy's identifier and version. To get these values, you can use
ListResponseHeadersPoliciesorGetResponseHeadersPolicy.- Parameters:
deleteResponseHeadersPolicyRequest-- Returns:
- Result of the DeleteResponseHeadersPolicy operation returned by the service.
- See Also:
-
deleteResponseHeadersPolicy
default DeleteResponseHeadersPolicyResponse deleteResponseHeadersPolicy(Consumer<DeleteResponseHeadersPolicyRequest.Builder> deleteResponseHeadersPolicyRequest) throws AccessDeniedException, InvalidIfMatchVersionException, NoSuchResponseHeadersPolicyException, PreconditionFailedException, IllegalDeleteException, ResponseHeadersPolicyInUseException, AwsServiceException, SdkClientException, CloudFrontException Deletes a response headers policy.
You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy's identifier and version. To get these values, you can use
ListResponseHeadersPoliciesorGetResponseHeadersPolicy.
This is a convenience which creates an instance of the
DeleteResponseHeadersPolicyRequest.Builderavoiding the need to create one manually viaDeleteResponseHeadersPolicyRequest.builder()- Parameters:
deleteResponseHeadersPolicyRequest- AConsumerthat will call methods onDeleteResponseHeadersPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteResponseHeadersPolicy operation returned by the service.
- See Also:
-
deleteStreamingDistribution
default DeleteStreamingDistributionResponse deleteStreamingDistribution(DeleteStreamingDistributionRequest deleteStreamingDistributionRequest) throws AccessDeniedException, StreamingDistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchStreamingDistributionException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
-
Disable the RTMP distribution.
-
Submit a
GET Streaming Distribution Configrequest to get the current configuration and theEtagheader for the distribution. -
Update the XML document that was returned in the response to your
GET Streaming Distribution Configrequest to change the value ofEnabledtofalse. -
Submit a
PUT Streaming Distribution Configrequest to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Streaming Distribution Configrequest in Step 2. -
Review the response to the
PUT Streaming Distribution Configrequest to confirm that the distribution was successfully disabled. -
Submit a
GET Streaming Distribution Configrequest to confirm that your changes have propagated. When propagation is complete, the value ofStatusisDeployed. -
Submit a
DELETE Streaming Distributionrequest. Set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Streaming Distribution Configrequest in Step 2. -
Review the response to your
DELETE Streaming Distributionrequest to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
- Parameters:
deleteStreamingDistributionRequest- The request to delete a streaming distribution.- Returns:
- Result of the DeleteStreamingDistribution operation returned by the service.
- See Also:
-
-
deleteStreamingDistribution
default DeleteStreamingDistributionResponse deleteStreamingDistribution(Consumer<DeleteStreamingDistributionRequest.Builder> deleteStreamingDistributionRequest) throws AccessDeniedException, StreamingDistributionNotDisabledException, InvalidIfMatchVersionException, NoSuchStreamingDistributionException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
-
Disable the RTMP distribution.
-
Submit a
GET Streaming Distribution Configrequest to get the current configuration and theEtagheader for the distribution. -
Update the XML document that was returned in the response to your
GET Streaming Distribution Configrequest to change the value ofEnabledtofalse. -
Submit a
PUT Streaming Distribution Configrequest to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Streaming Distribution Configrequest in Step 2. -
Review the response to the
PUT Streaming Distribution Configrequest to confirm that the distribution was successfully disabled. -
Submit a
GET Streaming Distribution Configrequest to confirm that your changes have propagated. When propagation is complete, the value ofStatusisDeployed. -
Submit a
DELETE Streaming Distributionrequest. Set the value of the HTTPIf-Matchheader to the value of theETagheader that CloudFront returned when you submitted theGET Streaming Distribution Configrequest in Step 2. -
Review the response to your
DELETE Streaming Distributionrequest to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
DeleteStreamingDistributionRequest.Builderavoiding the need to create one manually viaDeleteStreamingDistributionRequest.builder()- Parameters:
deleteStreamingDistributionRequest- AConsumerthat will call methods onDeleteStreamingDistributionRequest.Builderto create a request. The request to delete a streaming distribution.- Returns:
- Result of the DeleteStreamingDistribution operation returned by the service.
- See Also:
-
-
describeFunction
default DescribeFunctionResponse describeFunction(DescribeFunctionRequest describeFunctionRequest) throws NoSuchFunctionExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Gets configuration information and metadata about a CloudFront function, but not the function's code. To get a function's code, use
GetFunction.To get configuration information and metadata about a function, you must provide the function's name and stage. To get these values, you can use
ListFunctions.- Parameters:
describeFunctionRequest-- Returns:
- Result of the DescribeFunction operation returned by the service.
- See Also:
-
describeFunction
default DescribeFunctionResponse describeFunction(Consumer<DescribeFunctionRequest.Builder> describeFunctionRequest) throws NoSuchFunctionExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Gets configuration information and metadata about a CloudFront function, but not the function's code. To get a function's code, use
GetFunction.To get configuration information and metadata about a function, you must provide the function's name and stage. To get these values, you can use
ListFunctions.
This is a convenience which creates an instance of the
DescribeFunctionRequest.Builderavoiding the need to create one manually viaDescribeFunctionRequest.builder()- Parameters:
describeFunctionRequest- AConsumerthat will call methods onDescribeFunctionRequest.Builderto create a request.- Returns:
- Result of the DescribeFunction operation returned by the service.
- See Also:
-
describeKeyValueStore
default DescribeKeyValueStoreResponse describeKeyValueStore(DescribeKeyValueStoreRequest describeKeyValueStoreRequest) throws AccessDeniedException, InvalidArgumentException, EntityNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value store and its configuration.
- Parameters:
describeKeyValueStoreRequest-- Returns:
- Result of the DescribeKeyValueStore operation returned by the service.
- See Also:
-
describeKeyValueStore
default DescribeKeyValueStoreResponse describeKeyValueStore(Consumer<DescribeKeyValueStoreRequest.Builder> describeKeyValueStoreRequest) throws AccessDeniedException, InvalidArgumentException, EntityNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value store and its configuration.
This is a convenience which creates an instance of the
DescribeKeyValueStoreRequest.Builderavoiding the need to create one manually viaDescribeKeyValueStoreRequest.builder()- Parameters:
describeKeyValueStoreRequest- AConsumerthat will call methods onDescribeKeyValueStoreRequest.Builderto create a request.- Returns:
- Result of the DescribeKeyValueStore operation returned by the service.
- See Also:
-
getCachePolicy
default GetCachePolicyResponse getCachePolicy(GetCachePolicyRequest getCachePolicyRequest) throws AccessDeniedException, NoSuchCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a cache policy, including the following metadata:
-
The policy's identifier.
-
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier usingListCachePolicies.- Parameters:
getCachePolicyRequest-- Returns:
- Result of the GetCachePolicy operation returned by the service.
- See Also:
-
-
getCachePolicy
default GetCachePolicyResponse getCachePolicy(Consumer<GetCachePolicyRequest.Builder> getCachePolicyRequest) throws AccessDeniedException, NoSuchCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a cache policy, including the following metadata:
-
The policy's identifier.
-
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier usingListCachePolicies.
This is a convenience which creates an instance of the
GetCachePolicyRequest.Builderavoiding the need to create one manually viaGetCachePolicyRequest.builder()- Parameters:
getCachePolicyRequest- AConsumerthat will call methods onGetCachePolicyRequest.Builderto create a request.- Returns:
- Result of the GetCachePolicy operation returned by the service.
- See Also:
-
-
getCachePolicyConfig
default GetCachePolicyConfigResponse getCachePolicyConfig(GetCachePolicyConfigRequest getCachePolicyConfigRequest) throws AccessDeniedException, NoSuchCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier usingListCachePolicies.- Parameters:
getCachePolicyConfigRequest-- Returns:
- Result of the GetCachePolicyConfig operation returned by the service.
- See Also:
-
getCachePolicyConfig
default GetCachePolicyConfigResponse getCachePolicyConfig(Consumer<GetCachePolicyConfigRequest.Builder> getCachePolicyConfigRequest) throws AccessDeniedException, NoSuchCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier usingListCachePolicies.
This is a convenience which creates an instance of the
GetCachePolicyConfigRequest.Builderavoiding the need to create one manually viaGetCachePolicyConfigRequest.builder()- Parameters:
getCachePolicyConfigRequest- AConsumerthat will call methods onGetCachePolicyConfigRequest.Builderto create a request.- Returns:
- Result of the GetCachePolicyConfig operation returned by the service.
- See Also:
-
getCloudFrontOriginAccessIdentity
default GetCloudFrontOriginAccessIdentityResponse getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityRequest getCloudFrontOriginAccessIdentityRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the information about an origin access identity.
- Parameters:
getCloudFrontOriginAccessIdentityRequest- The request to get an origin access identity's information.- Returns:
- Result of the GetCloudFrontOriginAccessIdentity operation returned by the service.
- See Also:
-
getCloudFrontOriginAccessIdentity
default GetCloudFrontOriginAccessIdentityResponse getCloudFrontOriginAccessIdentity(Consumer<GetCloudFrontOriginAccessIdentityRequest.Builder> getCloudFrontOriginAccessIdentityRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the information about an origin access identity.
This is a convenience which creates an instance of the
GetCloudFrontOriginAccessIdentityRequest.Builderavoiding the need to create one manually viaGetCloudFrontOriginAccessIdentityRequest.builder()- Parameters:
getCloudFrontOriginAccessIdentityRequest- AConsumerthat will call methods onGetCloudFrontOriginAccessIdentityRequest.Builderto create a request. The request to get an origin access identity's information.- Returns:
- Result of the GetCloudFrontOriginAccessIdentity operation returned by the service.
- See Also:
-
getCloudFrontOriginAccessIdentityConfig
default GetCloudFrontOriginAccessIdentityConfigResponse getCloudFrontOriginAccessIdentityConfig(GetCloudFrontOriginAccessIdentityConfigRequest getCloudFrontOriginAccessIdentityConfigRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the configuration information about an origin access identity.
- Parameters:
getCloudFrontOriginAccessIdentityConfigRequest- The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.- Returns:
- Result of the GetCloudFrontOriginAccessIdentityConfig operation returned by the service.
- See Also:
-
getCloudFrontOriginAccessIdentityConfig
default GetCloudFrontOriginAccessIdentityConfigResponse getCloudFrontOriginAccessIdentityConfig(Consumer<GetCloudFrontOriginAccessIdentityConfigRequest.Builder> getCloudFrontOriginAccessIdentityConfigRequest) throws NoSuchCloudFrontOriginAccessIdentityException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the configuration information about an origin access identity.
This is a convenience which creates an instance of the
GetCloudFrontOriginAccessIdentityConfigRequest.Builderavoiding the need to create one manually viaGetCloudFrontOriginAccessIdentityConfigRequest.builder()- Parameters:
getCloudFrontOriginAccessIdentityConfigRequest- AConsumerthat will call methods onGetCloudFrontOriginAccessIdentityConfigRequest.Builderto create a request. The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.- Returns:
- Result of the GetCloudFrontOriginAccessIdentityConfig operation returned by the service.
- See Also:
-
getContinuousDeploymentPolicy
default GetContinuousDeploymentPolicyResponse getContinuousDeploymentPolicy(GetContinuousDeploymentPolicyRequest getContinuousDeploymentPolicyRequest) throws AccessDeniedException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
- Parameters:
getContinuousDeploymentPolicyRequest-- Returns:
- Result of the GetContinuousDeploymentPolicy operation returned by the service.
- See Also:
-
getContinuousDeploymentPolicy
default GetContinuousDeploymentPolicyResponse getContinuousDeploymentPolicy(Consumer<GetContinuousDeploymentPolicyRequest.Builder> getContinuousDeploymentPolicyRequest) throws AccessDeniedException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
This is a convenience which creates an instance of the
GetContinuousDeploymentPolicyRequest.Builderavoiding the need to create one manually viaGetContinuousDeploymentPolicyRequest.builder()- Parameters:
getContinuousDeploymentPolicyRequest- AConsumerthat will call methods onGetContinuousDeploymentPolicyRequest.Builderto create a request.- Returns:
- Result of the GetContinuousDeploymentPolicy operation returned by the service.
- See Also:
-
getContinuousDeploymentPolicyConfig
default GetContinuousDeploymentPolicyConfigResponse getContinuousDeploymentPolicyConfig(GetContinuousDeploymentPolicyConfigRequest getContinuousDeploymentPolicyConfigRequest) throws AccessDeniedException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets configuration information about a continuous deployment policy.
- Parameters:
getContinuousDeploymentPolicyConfigRequest-- Returns:
- Result of the GetContinuousDeploymentPolicyConfig operation returned by the service.
- See Also:
-
getContinuousDeploymentPolicyConfig
default GetContinuousDeploymentPolicyConfigResponse getContinuousDeploymentPolicyConfig(Consumer<GetContinuousDeploymentPolicyConfigRequest.Builder> getContinuousDeploymentPolicyConfigRequest) throws AccessDeniedException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets configuration information about a continuous deployment policy.
This is a convenience which creates an instance of the
GetContinuousDeploymentPolicyConfigRequest.Builderavoiding the need to create one manually viaGetContinuousDeploymentPolicyConfigRequest.builder()- Parameters:
getContinuousDeploymentPolicyConfigRequest- AConsumerthat will call methods onGetContinuousDeploymentPolicyConfigRequest.Builderto create a request.- Returns:
- Result of the GetContinuousDeploymentPolicyConfig operation returned by the service.
- See Also:
-
getDistribution
default GetDistributionResponse getDistribution(GetDistributionRequest getDistributionRequest) throws NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the information about a distribution.
- Parameters:
getDistributionRequest- The request to get a distribution's information.- Returns:
- Result of the GetDistribution operation returned by the service.
- See Also:
-
getDistribution
default GetDistributionResponse getDistribution(Consumer<GetDistributionRequest.Builder> getDistributionRequest) throws NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the information about a distribution.
This is a convenience which creates an instance of the
GetDistributionRequest.Builderavoiding the need to create one manually viaGetDistributionRequest.builder()- Parameters:
getDistributionRequest- AConsumerthat will call methods onGetDistributionRequest.Builderto create a request. The request to get a distribution's information.- Returns:
- Result of the GetDistribution operation returned by the service.
- See Also:
-
getDistributionConfig
default GetDistributionConfigResponse getDistributionConfig(GetDistributionConfigRequest getDistributionConfigRequest) throws NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the configuration information about a distribution.
- Parameters:
getDistributionConfigRequest- The request to get a distribution configuration.- Returns:
- Result of the GetDistributionConfig operation returned by the service.
- See Also:
-
getDistributionConfig
default GetDistributionConfigResponse getDistributionConfig(Consumer<GetDistributionConfigRequest.Builder> getDistributionConfigRequest) throws NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the configuration information about a distribution.
This is a convenience which creates an instance of the
GetDistributionConfigRequest.Builderavoiding the need to create one manually viaGetDistributionConfigRequest.builder()- Parameters:
getDistributionConfigRequest- AConsumerthat will call methods onGetDistributionConfigRequest.Builderto create a request. The request to get a distribution configuration.- Returns:
- Result of the GetDistributionConfig operation returned by the service.
- See Also:
-
getFieldLevelEncryption
default GetFieldLevelEncryptionResponse getFieldLevelEncryption(GetFieldLevelEncryptionRequest getFieldLevelEncryptionRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException Get the field-level encryption configuration information.
- Parameters:
getFieldLevelEncryptionRequest-- Returns:
- Result of the GetFieldLevelEncryption operation returned by the service.
- See Also:
-
getFieldLevelEncryption
default GetFieldLevelEncryptionResponse getFieldLevelEncryption(Consumer<GetFieldLevelEncryptionRequest.Builder> getFieldLevelEncryptionRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException Get the field-level encryption configuration information.
This is a convenience which creates an instance of the
GetFieldLevelEncryptionRequest.Builderavoiding the need to create one manually viaGetFieldLevelEncryptionRequest.builder()- Parameters:
getFieldLevelEncryptionRequest- AConsumerthat will call methods onGetFieldLevelEncryptionRequest.Builderto create a request.- Returns:
- Result of the GetFieldLevelEncryption operation returned by the service.
- See Also:
-
getFieldLevelEncryptionConfig
default GetFieldLevelEncryptionConfigResponse getFieldLevelEncryptionConfig(GetFieldLevelEncryptionConfigRequest getFieldLevelEncryptionConfigRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException Get the field-level encryption configuration information.
- Parameters:
getFieldLevelEncryptionConfigRequest-- Returns:
- Result of the GetFieldLevelEncryptionConfig operation returned by the service.
- See Also:
-
getFieldLevelEncryptionConfig
default GetFieldLevelEncryptionConfigResponse getFieldLevelEncryptionConfig(Consumer<GetFieldLevelEncryptionConfigRequest.Builder> getFieldLevelEncryptionConfigRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionConfigException, AwsServiceException, SdkClientException, CloudFrontException Get the field-level encryption configuration information.
This is a convenience which creates an instance of the
GetFieldLevelEncryptionConfigRequest.Builderavoiding the need to create one manually viaGetFieldLevelEncryptionConfigRequest.builder()- Parameters:
getFieldLevelEncryptionConfigRequest- AConsumerthat will call methods onGetFieldLevelEncryptionConfigRequest.Builderto create a request.- Returns:
- Result of the GetFieldLevelEncryptionConfig operation returned by the service.
- See Also:
-
getFieldLevelEncryptionProfile
default GetFieldLevelEncryptionProfileResponse getFieldLevelEncryptionProfile(GetFieldLevelEncryptionProfileRequest getFieldLevelEncryptionProfileRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionProfileException, AwsServiceException, SdkClientException, CloudFrontException Get the field-level encryption profile information.
- Parameters:
getFieldLevelEncryptionProfileRequest-- Returns:
- Result of the GetFieldLevelEncryptionProfile operation returned by the service.
- See Also:
-
getFieldLevelEncryptionProfile
default GetFieldLevelEncryptionProfileResponse getFieldLevelEncryptionProfile(Consumer<GetFieldLevelEncryptionProfileRequest.Builder> getFieldLevelEncryptionProfileRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionProfileException, AwsServiceException, SdkClientException, CloudFrontException Get the field-level encryption profile information.
This is a convenience which creates an instance of the
GetFieldLevelEncryptionProfileRequest.Builderavoiding the need to create one manually viaGetFieldLevelEncryptionProfileRequest.builder()- Parameters:
getFieldLevelEncryptionProfileRequest- AConsumerthat will call methods onGetFieldLevelEncryptionProfileRequest.Builderto create a request.- Returns:
- Result of the GetFieldLevelEncryptionProfile operation returned by the service.
- See Also:
-
getFieldLevelEncryptionProfileConfig
default GetFieldLevelEncryptionProfileConfigResponse getFieldLevelEncryptionProfileConfig(GetFieldLevelEncryptionProfileConfigRequest getFieldLevelEncryptionProfileConfigRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionProfileException, AwsServiceException, SdkClientException, CloudFrontException Get the field-level encryption profile configuration information.
- Parameters:
getFieldLevelEncryptionProfileConfigRequest-- Returns:
- Result of the GetFieldLevelEncryptionProfileConfig operation returned by the service.
- See Also:
-
getFieldLevelEncryptionProfileConfig
default GetFieldLevelEncryptionProfileConfigResponse getFieldLevelEncryptionProfileConfig(Consumer<GetFieldLevelEncryptionProfileConfigRequest.Builder> getFieldLevelEncryptionProfileConfigRequest) throws AccessDeniedException, NoSuchFieldLevelEncryptionProfileException, AwsServiceException, SdkClientException, CloudFrontException Get the field-level encryption profile configuration information.
This is a convenience which creates an instance of the
GetFieldLevelEncryptionProfileConfigRequest.Builderavoiding the need to create one manually viaGetFieldLevelEncryptionProfileConfigRequest.builder()- Parameters:
getFieldLevelEncryptionProfileConfigRequest- AConsumerthat will call methods onGetFieldLevelEncryptionProfileConfigRequest.Builderto create a request.- Returns:
- Result of the GetFieldLevelEncryptionProfileConfig operation returned by the service.
- See Also:
-
getFunction
default GetFunctionResponse getFunction(GetFunctionRequest getFunctionRequest) throws NoSuchFunctionExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Gets the code of a CloudFront function. To get configuration information and metadata about a function, use
DescribeFunction.To get a function's code, you must provide the function's name and stage. To get these values, you can use
ListFunctions.- Parameters:
getFunctionRequest-- Returns:
- Result of the GetFunction operation returned by the service.
- See Also:
-
getFunction
default GetFunctionResponse getFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest) throws NoSuchFunctionExistsException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Gets the code of a CloudFront function. To get configuration information and metadata about a function, use
DescribeFunction.To get a function's code, you must provide the function's name and stage. To get these values, you can use
ListFunctions.
This is a convenience which creates an instance of the
GetFunctionRequest.Builderavoiding the need to create one manually viaGetFunctionRequest.builder()- Parameters:
getFunctionRequest- AConsumerthat will call methods onGetFunctionRequest.Builderto create a request.- Returns:
- Result of the GetFunction operation returned by the service.
- See Also:
-
getInvalidation
default GetInvalidationResponse getInvalidation(GetInvalidationRequest getInvalidationRequest) throws NoSuchInvalidationException, NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the information about an invalidation.
- Parameters:
getInvalidationRequest- The request to get an invalidation's information.- Returns:
- Result of the GetInvalidation operation returned by the service.
- See Also:
-
getInvalidation
default GetInvalidationResponse getInvalidation(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest) throws NoSuchInvalidationException, NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the information about an invalidation.
This is a convenience which creates an instance of the
GetInvalidationRequest.Builderavoiding the need to create one manually viaGetInvalidationRequest.builder()- Parameters:
getInvalidationRequest- AConsumerthat will call methods onGetInvalidationRequest.Builderto create a request. The request to get an invalidation's information.- Returns:
- Result of the GetInvalidation operation returned by the service.
- See Also:
-
getKeyGroup
default GetKeyGroupResponse getKeyGroup(GetKeyGroupRequest getKeyGroupRequest) throws NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using
ListDistributionsorGetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier usingListKeyGroups.- Parameters:
getKeyGroupRequest-- Returns:
- Result of the GetKeyGroup operation returned by the service.
- See Also:
-
getKeyGroup
default GetKeyGroupResponse getKeyGroup(Consumer<GetKeyGroupRequest.Builder> getKeyGroupRequest) throws NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using
ListDistributionsorGetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier usingListKeyGroups.
This is a convenience which creates an instance of the
GetKeyGroupRequest.Builderavoiding the need to create one manually viaGetKeyGroupRequest.builder()- Parameters:
getKeyGroupRequest- AConsumerthat will call methods onGetKeyGroupRequest.Builderto create a request.- Returns:
- Result of the GetKeyGroup operation returned by the service.
- See Also:
-
getKeyGroupConfig
default GetKeyGroupConfigResponse getKeyGroupConfig(GetKeyGroupConfigRequest getKeyGroupConfigRequest) throws NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException Gets a key group configuration.
To get a key group configuration, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using
ListDistributionsorGetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier usingListKeyGroups.- Parameters:
getKeyGroupConfigRequest-- Returns:
- Result of the GetKeyGroupConfig operation returned by the service.
- See Also:
-
getKeyGroupConfig
default GetKeyGroupConfigResponse getKeyGroupConfig(Consumer<GetKeyGroupConfigRequest.Builder> getKeyGroupConfigRequest) throws NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException Gets a key group configuration.
To get a key group configuration, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using
ListDistributionsorGetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier usingListKeyGroups.
This is a convenience which creates an instance of the
GetKeyGroupConfigRequest.Builderavoiding the need to create one manually viaGetKeyGroupConfigRequest.builder()- Parameters:
getKeyGroupConfigRequest- AConsumerthat will call methods onGetKeyGroupConfigRequest.Builderto create a request.- Returns:
- Result of the GetKeyGroupConfig operation returned by the service.
- See Also:
-
getMonitoringSubscription
default GetMonitoringSubscriptionResponse getMonitoringSubscription(GetMonitoringSubscriptionRequest getMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, NoSuchMonitoringSubscriptionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
- Parameters:
getMonitoringSubscriptionRequest-- Returns:
- Result of the GetMonitoringSubscription operation returned by the service.
- See Also:
-
getMonitoringSubscription
default GetMonitoringSubscriptionResponse getMonitoringSubscription(Consumer<GetMonitoringSubscriptionRequest.Builder> getMonitoringSubscriptionRequest) throws AccessDeniedException, NoSuchDistributionException, NoSuchMonitoringSubscriptionException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
This is a convenience which creates an instance of the
GetMonitoringSubscriptionRequest.Builderavoiding the need to create one manually viaGetMonitoringSubscriptionRequest.builder()- Parameters:
getMonitoringSubscriptionRequest- AConsumerthat will call methods onGetMonitoringSubscriptionRequest.Builderto create a request.- Returns:
- Result of the GetMonitoringSubscription operation returned by the service.
- See Also:
-
getOriginAccessControl
default GetOriginAccessControlResponse getOriginAccessControl(GetOriginAccessControlRequest getOriginAccessControlRequest) throws NoSuchOriginAccessControlException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a CloudFront origin access control, including its unique identifier.
- Parameters:
getOriginAccessControlRequest-- Returns:
- Result of the GetOriginAccessControl operation returned by the service.
- See Also:
-
getOriginAccessControl
default GetOriginAccessControlResponse getOriginAccessControl(Consumer<GetOriginAccessControlRequest.Builder> getOriginAccessControlRequest) throws NoSuchOriginAccessControlException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a CloudFront origin access control, including its unique identifier.
This is a convenience which creates an instance of the
GetOriginAccessControlRequest.Builderavoiding the need to create one manually viaGetOriginAccessControlRequest.builder()- Parameters:
getOriginAccessControlRequest- AConsumerthat will call methods onGetOriginAccessControlRequest.Builderto create a request.- Returns:
- Result of the GetOriginAccessControl operation returned by the service.
- See Also:
-
getOriginAccessControlConfig
default GetOriginAccessControlConfigResponse getOriginAccessControlConfig(GetOriginAccessControlConfigRequest getOriginAccessControlConfigRequest) throws NoSuchOriginAccessControlException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a CloudFront origin access control configuration.
- Parameters:
getOriginAccessControlConfigRequest-- Returns:
- Result of the GetOriginAccessControlConfig operation returned by the service.
- See Also:
-
getOriginAccessControlConfig
default GetOriginAccessControlConfigResponse getOriginAccessControlConfig(Consumer<GetOriginAccessControlConfigRequest.Builder> getOriginAccessControlConfigRequest) throws NoSuchOriginAccessControlException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a CloudFront origin access control configuration.
This is a convenience which creates an instance of the
GetOriginAccessControlConfigRequest.Builderavoiding the need to create one manually viaGetOriginAccessControlConfigRequest.builder()- Parameters:
getOriginAccessControlConfigRequest- AConsumerthat will call methods onGetOriginAccessControlConfigRequest.Builderto create a request.- Returns:
- Result of the GetOriginAccessControlConfig operation returned by the service.
- See Also:
-
getOriginRequestPolicy
default GetOriginRequestPolicyResponse getOriginRequestPolicy(GetOriginRequestPolicyRequest getOriginRequestPolicyRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets an origin request policy, including the following metadata:
-
The policy's identifier.
-
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier usingListOriginRequestPolicies.- Parameters:
getOriginRequestPolicyRequest-- Returns:
- Result of the GetOriginRequestPolicy operation returned by the service.
- See Also:
-
-
getOriginRequestPolicy
default GetOriginRequestPolicyResponse getOriginRequestPolicy(Consumer<GetOriginRequestPolicyRequest.Builder> getOriginRequestPolicyRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets an origin request policy, including the following metadata:
-
The policy's identifier.
-
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier usingListOriginRequestPolicies.
This is a convenience which creates an instance of the
GetOriginRequestPolicyRequest.Builderavoiding the need to create one manually viaGetOriginRequestPolicyRequest.builder()- Parameters:
getOriginRequestPolicyRequest- AConsumerthat will call methods onGetOriginRequestPolicyRequest.Builderto create a request.- Returns:
- Result of the GetOriginRequestPolicy operation returned by the service.
- See Also:
-
-
getOriginRequestPolicyConfig
default GetOriginRequestPolicyConfigResponse getOriginRequestPolicyConfig(GetOriginRequestPolicyConfigRequest getOriginRequestPolicyConfigRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier usingListOriginRequestPolicies.- Parameters:
getOriginRequestPolicyConfigRequest-- Returns:
- Result of the GetOriginRequestPolicyConfig operation returned by the service.
- See Also:
-
getOriginRequestPolicyConfig
default GetOriginRequestPolicyConfigResponse getOriginRequestPolicyConfig(Consumer<GetOriginRequestPolicyConfigRequest.Builder> getOriginRequestPolicyConfigRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier usingListOriginRequestPolicies.
This is a convenience which creates an instance of the
GetOriginRequestPolicyConfigRequest.Builderavoiding the need to create one manually viaGetOriginRequestPolicyConfigRequest.builder()- Parameters:
getOriginRequestPolicyConfigRequest- AConsumerthat will call methods onGetOriginRequestPolicyConfigRequest.Builderto create a request.- Returns:
- Result of the GetOriginRequestPolicyConfig operation returned by the service.
- See Also:
-
getPublicKey
default GetPublicKeyResponse getPublicKey(GetPublicKeyRequest getPublicKeyRequest) throws AccessDeniedException, NoSuchPublicKeyException, AwsServiceException, SdkClientException, CloudFrontException Gets a public key.
- Parameters:
getPublicKeyRequest-- Returns:
- Result of the GetPublicKey operation returned by the service.
- See Also:
-
getPublicKey
default GetPublicKeyResponse getPublicKey(Consumer<GetPublicKeyRequest.Builder> getPublicKeyRequest) throws AccessDeniedException, NoSuchPublicKeyException, AwsServiceException, SdkClientException, CloudFrontException Gets a public key.
This is a convenience which creates an instance of the
GetPublicKeyRequest.Builderavoiding the need to create one manually viaGetPublicKeyRequest.builder()- Parameters:
getPublicKeyRequest- AConsumerthat will call methods onGetPublicKeyRequest.Builderto create a request.- Returns:
- Result of the GetPublicKey operation returned by the service.
- See Also:
-
getPublicKeyConfig
default GetPublicKeyConfigResponse getPublicKeyConfig(GetPublicKeyConfigRequest getPublicKeyConfigRequest) throws AccessDeniedException, NoSuchPublicKeyException, AwsServiceException, SdkClientException, CloudFrontException Gets a public key configuration.
- Parameters:
getPublicKeyConfigRequest-- Returns:
- Result of the GetPublicKeyConfig operation returned by the service.
- See Also:
-
getPublicKeyConfig
default GetPublicKeyConfigResponse getPublicKeyConfig(Consumer<GetPublicKeyConfigRequest.Builder> getPublicKeyConfigRequest) throws AccessDeniedException, NoSuchPublicKeyException, AwsServiceException, SdkClientException, CloudFrontException Gets a public key configuration.
This is a convenience which creates an instance of the
GetPublicKeyConfigRequest.Builderavoiding the need to create one manually viaGetPublicKeyConfigRequest.builder()- Parameters:
getPublicKeyConfigRequest- AConsumerthat will call methods onGetPublicKeyConfigRequest.Builderto create a request.- Returns:
- Result of the GetPublicKeyConfig operation returned by the service.
- See Also:
-
getRealtimeLogConfig
default GetRealtimeLogConfigResponse getRealtimeLogConfig(GetRealtimeLogConfigRequest getRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
- Parameters:
getRealtimeLogConfigRequest-- Returns:
- Result of the GetRealtimeLogConfig operation returned by the service.
- See Also:
-
getRealtimeLogConfig
default GetRealtimeLogConfigResponse getRealtimeLogConfig(Consumer<GetRealtimeLogConfigRequest.Builder> getRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
This is a convenience which creates an instance of the
GetRealtimeLogConfigRequest.Builderavoiding the need to create one manually viaGetRealtimeLogConfigRequest.builder()- Parameters:
getRealtimeLogConfigRequest- AConsumerthat will call methods onGetRealtimeLogConfigRequest.Builderto create a request.- Returns:
- Result of the GetRealtimeLogConfig operation returned by the service.
- See Also:
-
getResponseHeadersPolicy
default GetResponseHeadersPolicyResponse getResponseHeadersPolicy(GetResponseHeadersPolicyRequest getResponseHeadersPolicyRequest) throws AccessDeniedException, NoSuchResponseHeadersPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier usingListResponseHeadersPolicies.- Parameters:
getResponseHeadersPolicyRequest-- Returns:
- Result of the GetResponseHeadersPolicy operation returned by the service.
- See Also:
-
getResponseHeadersPolicy
default GetResponseHeadersPolicyResponse getResponseHeadersPolicy(Consumer<GetResponseHeadersPolicyRequest.Builder> getResponseHeadersPolicyRequest) throws AccessDeniedException, NoSuchResponseHeadersPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier usingListResponseHeadersPolicies.
This is a convenience which creates an instance of the
GetResponseHeadersPolicyRequest.Builderavoiding the need to create one manually viaGetResponseHeadersPolicyRequest.builder()- Parameters:
getResponseHeadersPolicyRequest- AConsumerthat will call methods onGetResponseHeadersPolicyRequest.Builderto create a request.- Returns:
- Result of the GetResponseHeadersPolicy operation returned by the service.
- See Also:
-
getResponseHeadersPolicyConfig
default GetResponseHeadersPolicyConfigResponse getResponseHeadersPolicyConfig(GetResponseHeadersPolicyConfigRequest getResponseHeadersPolicyConfigRequest) throws AccessDeniedException, NoSuchResponseHeadersPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier usingListResponseHeadersPolicies.- Parameters:
getResponseHeadersPolicyConfigRequest-- Returns:
- Result of the GetResponseHeadersPolicyConfig operation returned by the service.
- See Also:
-
getResponseHeadersPolicyConfig
default GetResponseHeadersPolicyConfigResponse getResponseHeadersPolicyConfig(Consumer<GetResponseHeadersPolicyConfigRequest.Builder> getResponseHeadersPolicyConfigRequest) throws AccessDeniedException, NoSuchResponseHeadersPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using
ListDistributionsorGetDistribution. If the response headers policy is not attached to a cache behavior, you can get the identifier usingListResponseHeadersPolicies.
This is a convenience which creates an instance of the
GetResponseHeadersPolicyConfigRequest.Builderavoiding the need to create one manually viaGetResponseHeadersPolicyConfigRequest.builder()- Parameters:
getResponseHeadersPolicyConfigRequest- AConsumerthat will call methods onGetResponseHeadersPolicyConfigRequest.Builderto create a request.- Returns:
- Result of the GetResponseHeadersPolicyConfig operation returned by the service.
- See Also:
-
getStreamingDistribution
default GetStreamingDistributionResponse getStreamingDistribution(GetStreamingDistributionRequest getStreamingDistributionRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets information about a specified RTMP distribution, including the distribution configuration.
- Parameters:
getStreamingDistributionRequest- The request to get a streaming distribution's information.- Returns:
- Result of the GetStreamingDistribution operation returned by the service.
- See Also:
-
getStreamingDistribution
default GetStreamingDistributionResponse getStreamingDistribution(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets information about a specified RTMP distribution, including the distribution configuration.
This is a convenience which creates an instance of the
GetStreamingDistributionRequest.Builderavoiding the need to create one manually viaGetStreamingDistributionRequest.builder()- Parameters:
getStreamingDistributionRequest- AConsumerthat will call methods onGetStreamingDistributionRequest.Builderto create a request. The request to get a streaming distribution's information.- Returns:
- Result of the GetStreamingDistribution operation returned by the service.
- See Also:
-
getStreamingDistributionConfig
default GetStreamingDistributionConfigResponse getStreamingDistributionConfig(GetStreamingDistributionConfigRequest getStreamingDistributionConfigRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the configuration information about a streaming distribution.
- Parameters:
getStreamingDistributionConfigRequest- To request to get a streaming distribution configuration.- Returns:
- Result of the GetStreamingDistributionConfig operation returned by the service.
- See Also:
-
getStreamingDistributionConfig
default GetStreamingDistributionConfigResponse getStreamingDistributionConfig(Consumer<GetStreamingDistributionConfigRequest.Builder> getStreamingDistributionConfigRequest) throws NoSuchStreamingDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Get the configuration information about a streaming distribution.
This is a convenience which creates an instance of the
GetStreamingDistributionConfigRequest.Builderavoiding the need to create one manually viaGetStreamingDistributionConfigRequest.builder()- Parameters:
getStreamingDistributionConfigRequest- AConsumerthat will call methods onGetStreamingDistributionConfigRequest.Builderto create a request. To request to get a streaming distribution configuration.- Returns:
- Result of the GetStreamingDistributionConfig operation returned by the service.
- See Also:
-
listCachePolicies
default ListCachePoliciesResponse listCachePolicies(ListCachePoliciesRequest listCachePoliciesRequest) throws AccessDeniedException, NoSuchCachePolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listCachePoliciesRequest-- Returns:
- Result of the ListCachePolicies operation returned by the service.
- See Also:
-
listCachePolicies
default ListCachePoliciesResponse listCachePolicies(Consumer<ListCachePoliciesRequest.Builder> listCachePoliciesRequest) throws AccessDeniedException, NoSuchCachePolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListCachePoliciesRequest.Builderavoiding the need to create one manually viaListCachePoliciesRequest.builder()- Parameters:
listCachePoliciesRequest- AConsumerthat will call methods onListCachePoliciesRequest.Builderto create a request.- Returns:
- Result of the ListCachePolicies operation returned by the service.
- See Also:
-
listCloudFrontOriginAccessIdentities
default ListCloudFrontOriginAccessIdentitiesResponse listCloudFrontOriginAccessIdentities(ListCloudFrontOriginAccessIdentitiesRequest listCloudFrontOriginAccessIdentitiesRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Lists origin access identities.
- Parameters:
listCloudFrontOriginAccessIdentitiesRequest- The request to list origin access identities.- Returns:
- Result of the ListCloudFrontOriginAccessIdentities operation returned by the service.
- See Also:
-
listCloudFrontOriginAccessIdentities
default ListCloudFrontOriginAccessIdentitiesResponse listCloudFrontOriginAccessIdentities(Consumer<ListCloudFrontOriginAccessIdentitiesRequest.Builder> listCloudFrontOriginAccessIdentitiesRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Lists origin access identities.
This is a convenience which creates an instance of the
ListCloudFrontOriginAccessIdentitiesRequest.Builderavoiding the need to create one manually viaListCloudFrontOriginAccessIdentitiesRequest.builder()- Parameters:
listCloudFrontOriginAccessIdentitiesRequest- AConsumerthat will call methods onListCloudFrontOriginAccessIdentitiesRequest.Builderto create a request. The request to list origin access identities.- Returns:
- Result of the ListCloudFrontOriginAccessIdentities operation returned by the service.
- See Also:
-
listCloudFrontOriginAccessIdentities
default ListCloudFrontOriginAccessIdentitiesResponse listCloudFrontOriginAccessIdentities() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontExceptionLists origin access identities.
- Returns:
- Result of the ListCloudFrontOriginAccessIdentities operation returned by the service.
- See Also:
-
listConflictingAliases
default ListConflictingAliasesResponse listConflictingAliases(ListConflictingAliasesRequest listConflictingAliasesRequest) throws InvalidArgumentException, NoSuchDistributionException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide
www.example.comas input, the returned list can includewww.example.comand the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide*.example.comas input, the returned list can include*.example.comand any alternate domain names covered by that wildcard (for example,www.example.com,test.example.com,dev.example.com, and so on), if they exist.To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listConflictingAliasesRequest-- Returns:
- Result of the ListConflictingAliases operation returned by the service.
- See Also:
-
listConflictingAliases
default ListConflictingAliasesResponse listConflictingAliases(Consumer<ListConflictingAliasesRequest.Builder> listConflictingAliasesRequest) throws InvalidArgumentException, NoSuchDistributionException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide
www.example.comas input, the returned list can includewww.example.comand the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide*.example.comas input, the returned list can include*.example.comand any alternate domain names covered by that wildcard (for example,www.example.com,test.example.com,dev.example.com, and so on), if they exist.To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListConflictingAliasesRequest.Builderavoiding the need to create one manually viaListConflictingAliasesRequest.builder()- Parameters:
listConflictingAliasesRequest- AConsumerthat will call methods onListConflictingAliasesRequest.Builderto create a request.- Returns:
- Result of the ListConflictingAliases operation returned by the service.
- See Also:
-
listContinuousDeploymentPolicies
default ListContinuousDeploymentPoliciesResponse listContinuousDeploymentPolicies(ListContinuousDeploymentPoliciesRequest listContinuousDeploymentPoliciesRequest) throws InvalidArgumentException, AccessDeniedException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of the continuous deployment policies in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listContinuousDeploymentPoliciesRequest-- Returns:
- Result of the ListContinuousDeploymentPolicies operation returned by the service.
- See Also:
-
listContinuousDeploymentPolicies
default ListContinuousDeploymentPoliciesResponse listContinuousDeploymentPolicies(Consumer<ListContinuousDeploymentPoliciesRequest.Builder> listContinuousDeploymentPoliciesRequest) throws InvalidArgumentException, AccessDeniedException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of the continuous deployment policies in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListContinuousDeploymentPoliciesRequest.Builderavoiding the need to create one manually viaListContinuousDeploymentPoliciesRequest.builder()- Parameters:
listContinuousDeploymentPoliciesRequest- AConsumerthat will call methods onListContinuousDeploymentPoliciesRequest.Builderto create a request.- Returns:
- Result of the ListContinuousDeploymentPolicies operation returned by the service.
- See Also:
-
listDistributions
default ListDistributionsResponse listDistributions(ListDistributionsRequest listDistributionsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException List CloudFront distributions.
- Parameters:
listDistributionsRequest- The request to list your distributions.- Returns:
- Result of the ListDistributions operation returned by the service.
- See Also:
-
listDistributions
default ListDistributionsResponse listDistributions(Consumer<ListDistributionsRequest.Builder> listDistributionsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException List CloudFront distributions.
This is a convenience which creates an instance of the
ListDistributionsRequest.Builderavoiding the need to create one manually viaListDistributionsRequest.builder()- Parameters:
listDistributionsRequest- AConsumerthat will call methods onListDistributionsRequest.Builderto create a request. The request to list your distributions.- Returns:
- Result of the ListDistributions operation returned by the service.
- See Also:
-
listDistributions
default ListDistributionsResponse listDistributions() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontExceptionList CloudFront distributions.
- Returns:
- Result of the ListDistributions operation returned by the service.
- See Also:
-
listDistributionsByCachePolicyId
default ListDistributionsByCachePolicyIdResponse listDistributionsByCachePolicyId(ListDistributionsByCachePolicyIdRequest listDistributionsByCachePolicyIdRequest) throws NoSuchCachePolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listDistributionsByCachePolicyIdRequest-- Returns:
- Result of the ListDistributionsByCachePolicyId operation returned by the service.
- See Also:
-
listDistributionsByCachePolicyId
default ListDistributionsByCachePolicyIdResponse listDistributionsByCachePolicyId(Consumer<ListDistributionsByCachePolicyIdRequest.Builder> listDistributionsByCachePolicyIdRequest) throws NoSuchCachePolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByCachePolicyIdRequest.Builderavoiding the need to create one manually viaListDistributionsByCachePolicyIdRequest.builder()- Parameters:
listDistributionsByCachePolicyIdRequest- AConsumerthat will call methods onListDistributionsByCachePolicyIdRequest.Builderto create a request.- Returns:
- Result of the ListDistributionsByCachePolicyId operation returned by the service.
- See Also:
-
listDistributionsByKeyGroup
default ListDistributionsByKeyGroupResponse listDistributionsByKeyGroup(ListDistributionsByKeyGroupRequest listDistributionsByKeyGroupRequest) throws NoSuchResourceException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listDistributionsByKeyGroupRequest-- Returns:
- Result of the ListDistributionsByKeyGroup operation returned by the service.
- See Also:
-
listDistributionsByKeyGroup
default ListDistributionsByKeyGroupResponse listDistributionsByKeyGroup(Consumer<ListDistributionsByKeyGroupRequest.Builder> listDistributionsByKeyGroupRequest) throws NoSuchResourceException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByKeyGroupRequest.Builderavoiding the need to create one manually viaListDistributionsByKeyGroupRequest.builder()- Parameters:
listDistributionsByKeyGroupRequest- AConsumerthat will call methods onListDistributionsByKeyGroupRequest.Builderto create a request.- Returns:
- Result of the ListDistributionsByKeyGroup operation returned by the service.
- See Also:
-
listDistributionsByOriginRequestPolicyId
default ListDistributionsByOriginRequestPolicyIdResponse listDistributionsByOriginRequestPolicyId(ListDistributionsByOriginRequestPolicyIdRequest listDistributionsByOriginRequestPolicyIdRequest) throws NoSuchOriginRequestPolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listDistributionsByOriginRequestPolicyIdRequest-- Returns:
- Result of the ListDistributionsByOriginRequestPolicyId operation returned by the service.
- See Also:
-
listDistributionsByOriginRequestPolicyId
default ListDistributionsByOriginRequestPolicyIdResponse listDistributionsByOriginRequestPolicyId(Consumer<ListDistributionsByOriginRequestPolicyIdRequest.Builder> listDistributionsByOriginRequestPolicyIdRequest) throws NoSuchOriginRequestPolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByOriginRequestPolicyIdRequest.Builderavoiding the need to create one manually viaListDistributionsByOriginRequestPolicyIdRequest.builder()- Parameters:
listDistributionsByOriginRequestPolicyIdRequest- AConsumerthat will call methods onListDistributionsByOriginRequestPolicyIdRequest.Builderto create a request.- Returns:
- Result of the ListDistributionsByOriginRequestPolicyId operation returned by the service.
- See Also:
-
listDistributionsByRealtimeLogConfig
default ListDistributionsByRealtimeLogConfigResponse listDistributionsByRealtimeLogConfig(ListDistributionsByRealtimeLogConfigRequest listDistributionsByRealtimeLogConfigRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listDistributionsByRealtimeLogConfigRequest-- Returns:
- Result of the ListDistributionsByRealtimeLogConfig operation returned by the service.
- See Also:
-
listDistributionsByRealtimeLogConfig
default ListDistributionsByRealtimeLogConfigResponse listDistributionsByRealtimeLogConfig(Consumer<ListDistributionsByRealtimeLogConfigRequest.Builder> listDistributionsByRealtimeLogConfigRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByRealtimeLogConfigRequest.Builderavoiding the need to create one manually viaListDistributionsByRealtimeLogConfigRequest.builder()- Parameters:
listDistributionsByRealtimeLogConfigRequest- AConsumerthat will call methods onListDistributionsByRealtimeLogConfigRequest.Builderto create a request.- Returns:
- Result of the ListDistributionsByRealtimeLogConfig operation returned by the service.
- See Also:
-
listDistributionsByResponseHeadersPolicyId
default ListDistributionsByResponseHeadersPolicyIdResponse listDistributionsByResponseHeadersPolicyId(ListDistributionsByResponseHeadersPolicyIdRequest listDistributionsByResponseHeadersPolicyIdRequest) throws NoSuchResponseHeadersPolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listDistributionsByResponseHeadersPolicyIdRequest-- Returns:
- Result of the ListDistributionsByResponseHeadersPolicyId operation returned by the service.
- See Also:
-
listDistributionsByResponseHeadersPolicyId
default ListDistributionsByResponseHeadersPolicyIdResponse listDistributionsByResponseHeadersPolicyId(Consumer<ListDistributionsByResponseHeadersPolicyIdRequest.Builder> listDistributionsByResponseHeadersPolicyIdRequest) throws NoSuchResponseHeadersPolicyException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByResponseHeadersPolicyIdRequest.Builderavoiding the need to create one manually viaListDistributionsByResponseHeadersPolicyIdRequest.builder()- Parameters:
listDistributionsByResponseHeadersPolicyIdRequest- AConsumerthat will call methods onListDistributionsByResponseHeadersPolicyIdRequest.Builderto create a request.- Returns:
- Result of the ListDistributionsByResponseHeadersPolicyId operation returned by the service.
- See Also:
-
listDistributionsByWebACLId
default ListDistributionsByWebAclIdResponse listDistributionsByWebACLId(ListDistributionsByWebAclIdRequest listDistributionsByWebAclIdRequest) throws InvalidArgumentException, InvalidWebAclIdException, AwsServiceException, SdkClientException, CloudFrontException List the distributions that are associated with a specified WAF web ACL.
- Parameters:
listDistributionsByWebAclIdRequest- The request to list distributions that are associated with a specified WAF web ACL.- Returns:
- Result of the ListDistributionsByWebACLId operation returned by the service.
- See Also:
-
listDistributionsByWebACLId
default ListDistributionsByWebAclIdResponse listDistributionsByWebACLId(Consumer<ListDistributionsByWebAclIdRequest.Builder> listDistributionsByWebAclIdRequest) throws InvalidArgumentException, InvalidWebAclIdException, AwsServiceException, SdkClientException, CloudFrontException List the distributions that are associated with a specified WAF web ACL.
This is a convenience which creates an instance of the
ListDistributionsByWebAclIdRequest.Builderavoiding the need to create one manually viaListDistributionsByWebAclIdRequest.builder()- Parameters:
listDistributionsByWebAclIdRequest- AConsumerthat will call methods onListDistributionsByWebAclIdRequest.Builderto create a request. The request to list distributions that are associated with a specified WAF web ACL.- Returns:
- Result of the ListDistributionsByWebACLId operation returned by the service.
- See Also:
-
listFieldLevelEncryptionConfigs
default ListFieldLevelEncryptionConfigsResponse listFieldLevelEncryptionConfigs(ListFieldLevelEncryptionConfigsRequest listFieldLevelEncryptionConfigsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException List all field-level encryption configurations that have been created in CloudFront for this account.
- Parameters:
listFieldLevelEncryptionConfigsRequest-- Returns:
- Result of the ListFieldLevelEncryptionConfigs operation returned by the service.
- See Also:
-
listFieldLevelEncryptionConfigs
default ListFieldLevelEncryptionConfigsResponse listFieldLevelEncryptionConfigs(Consumer<ListFieldLevelEncryptionConfigsRequest.Builder> listFieldLevelEncryptionConfigsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException List all field-level encryption configurations that have been created in CloudFront for this account.
This is a convenience which creates an instance of the
ListFieldLevelEncryptionConfigsRequest.Builderavoiding the need to create one manually viaListFieldLevelEncryptionConfigsRequest.builder()- Parameters:
listFieldLevelEncryptionConfigsRequest- AConsumerthat will call methods onListFieldLevelEncryptionConfigsRequest.Builderto create a request.- Returns:
- Result of the ListFieldLevelEncryptionConfigs operation returned by the service.
- See Also:
-
listFieldLevelEncryptionConfigs
default ListFieldLevelEncryptionConfigsResponse listFieldLevelEncryptionConfigs() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontExceptionList all field-level encryption configurations that have been created in CloudFront for this account.
- Returns:
- Result of the ListFieldLevelEncryptionConfigs operation returned by the service.
- See Also:
-
listFieldLevelEncryptionProfiles
default ListFieldLevelEncryptionProfilesResponse listFieldLevelEncryptionProfiles(ListFieldLevelEncryptionProfilesRequest listFieldLevelEncryptionProfilesRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Request a list of field-level encryption profiles that have been created in CloudFront for this account.
- Parameters:
listFieldLevelEncryptionProfilesRequest-- Returns:
- Result of the ListFieldLevelEncryptionProfiles operation returned by the service.
- See Also:
-
listFieldLevelEncryptionProfiles
default ListFieldLevelEncryptionProfilesResponse listFieldLevelEncryptionProfiles(Consumer<ListFieldLevelEncryptionProfilesRequest.Builder> listFieldLevelEncryptionProfilesRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Request a list of field-level encryption profiles that have been created in CloudFront for this account.
This is a convenience which creates an instance of the
ListFieldLevelEncryptionProfilesRequest.Builderavoiding the need to create one manually viaListFieldLevelEncryptionProfilesRequest.builder()- Parameters:
listFieldLevelEncryptionProfilesRequest- AConsumerthat will call methods onListFieldLevelEncryptionProfilesRequest.Builderto create a request.- Returns:
- Result of the ListFieldLevelEncryptionProfiles operation returned by the service.
- See Also:
-
listFieldLevelEncryptionProfiles
default ListFieldLevelEncryptionProfilesResponse listFieldLevelEncryptionProfiles() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontExceptionRequest a list of field-level encryption profiles that have been created in CloudFront for this account.
- Returns:
- Result of the ListFieldLevelEncryptionProfiles operation returned by the service.
- See Also:
-
listFunctions
default ListFunctionsResponse listFunctions(ListFunctionsRequest listFunctionsRequest) throws InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of all CloudFront functions in your Amazon Web Services account.
You can optionally apply a filter to return only the functions that are in the specified stage, either
DEVELOPMENTorLIVE.You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listFunctionsRequest-- Returns:
- Result of the ListFunctions operation returned by the service.
- See Also:
-
listFunctions
default ListFunctionsResponse listFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) throws InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of all CloudFront functions in your Amazon Web Services account.
You can optionally apply a filter to return only the functions that are in the specified stage, either
DEVELOPMENTorLIVE.You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListFunctionsRequest.Builderavoiding the need to create one manually viaListFunctionsRequest.builder()- Parameters:
listFunctionsRequest- AConsumerthat will call methods onListFunctionsRequest.Builderto create a request.- Returns:
- Result of the ListFunctions operation returned by the service.
- See Also:
-
listInvalidations
default ListInvalidationsResponse listInvalidations(ListInvalidationsRequest listInvalidationsRequest) throws InvalidArgumentException, NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Lists invalidation batches.
- Parameters:
listInvalidationsRequest- The request to list invalidations.- Returns:
- Result of the ListInvalidations operation returned by the service.
- See Also:
-
listInvalidations
default ListInvalidationsResponse listInvalidations(Consumer<ListInvalidationsRequest.Builder> listInvalidationsRequest) throws InvalidArgumentException, NoSuchDistributionException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Lists invalidation batches.
This is a convenience which creates an instance of the
ListInvalidationsRequest.Builderavoiding the need to create one manually viaListInvalidationsRequest.builder()- Parameters:
listInvalidationsRequest- AConsumerthat will call methods onListInvalidationsRequest.Builderto create a request. The request to list invalidations.- Returns:
- Result of the ListInvalidations operation returned by the service.
- See Also:
-
listKeyGroups
default ListKeyGroupsResponse listKeyGroups(ListKeyGroupsRequest listKeyGroupsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listKeyGroupsRequest-- Returns:
- Result of the ListKeyGroups operation returned by the service.
- See Also:
-
listKeyGroups
default ListKeyGroupsResponse listKeyGroups(Consumer<ListKeyGroupsRequest.Builder> listKeyGroupsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListKeyGroupsRequest.Builderavoiding the need to create one manually viaListKeyGroupsRequest.builder()- Parameters:
listKeyGroupsRequest- AConsumerthat will call methods onListKeyGroupsRequest.Builderto create a request.- Returns:
- Result of the ListKeyGroups operation returned by the service.
- See Also:
-
listKeyValueStores
default ListKeyValueStoresResponse listKeyValueStores(ListKeyValueStoresRequest listKeyValueStoresRequest) throws AccessDeniedException, InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value stores to list.
- Parameters:
listKeyValueStoresRequest-- Returns:
- Result of the ListKeyValueStores operation returned by the service.
- See Also:
-
listKeyValueStores
default ListKeyValueStoresResponse listKeyValueStores(Consumer<ListKeyValueStoresRequest.Builder> listKeyValueStoresRequest) throws AccessDeniedException, InvalidArgumentException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value stores to list.
This is a convenience which creates an instance of the
ListKeyValueStoresRequest.Builderavoiding the need to create one manually viaListKeyValueStoresRequest.builder()- Parameters:
listKeyValueStoresRequest- AConsumerthat will call methods onListKeyValueStoresRequest.Builderto create a request.- Returns:
- Result of the ListKeyValueStores operation returned by the service.
- See Also:
-
listOriginAccessControls
default ListOriginAccessControlsResponse listOriginAccessControls(ListOriginAccessControlsRequest listOriginAccessControlsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets the list of CloudFront origin access controls in this Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send another request that specifies the
NextMarkervalue from the current response as theMarkervalue in the next request.- Parameters:
listOriginAccessControlsRequest-- Returns:
- Result of the ListOriginAccessControls operation returned by the service.
- See Also:
-
listOriginAccessControls
default ListOriginAccessControlsResponse listOriginAccessControls(Consumer<ListOriginAccessControlsRequest.Builder> listOriginAccessControlsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets the list of CloudFront origin access controls in this Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send another request that specifies the
NextMarkervalue from the current response as theMarkervalue in the next request.
This is a convenience which creates an instance of the
ListOriginAccessControlsRequest.Builderavoiding the need to create one manually viaListOriginAccessControlsRequest.builder()- Parameters:
listOriginAccessControlsRequest- AConsumerthat will call methods onListOriginAccessControlsRequest.Builderto create a request.- Returns:
- Result of the ListOriginAccessControls operation returned by the service.
- See Also:
-
listOriginRequestPolicies
default ListOriginRequestPoliciesResponse listOriginRequestPolicies(ListOriginRequestPoliciesRequest listOriginRequestPoliciesRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listOriginRequestPoliciesRequest-- Returns:
- Result of the ListOriginRequestPolicies operation returned by the service.
- See Also:
-
listOriginRequestPolicies
default ListOriginRequestPoliciesResponse listOriginRequestPolicies(Consumer<ListOriginRequestPoliciesRequest.Builder> listOriginRequestPoliciesRequest) throws AccessDeniedException, NoSuchOriginRequestPolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListOriginRequestPoliciesRequest.Builderavoiding the need to create one manually viaListOriginRequestPoliciesRequest.builder()- Parameters:
listOriginRequestPoliciesRequest- AConsumerthat will call methods onListOriginRequestPoliciesRequest.Builderto create a request.- Returns:
- Result of the ListOriginRequestPolicies operation returned by the service.
- See Also:
-
listPublicKeys
default ListPublicKeysResponse listPublicKeys(ListPublicKeysRequest listPublicKeysRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException List all public keys that have been added to CloudFront for this account.
- Parameters:
listPublicKeysRequest-- Returns:
- Result of the ListPublicKeys operation returned by the service.
- See Also:
-
listPublicKeys
default ListPublicKeysResponse listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException List all public keys that have been added to CloudFront for this account.
This is a convenience which creates an instance of the
ListPublicKeysRequest.Builderavoiding the need to create one manually viaListPublicKeysRequest.builder()- Parameters:
listPublicKeysRequest- AConsumerthat will call methods onListPublicKeysRequest.Builderto create a request.- Returns:
- Result of the ListPublicKeys operation returned by the service.
- See Also:
-
listPublicKeys
default ListPublicKeysResponse listPublicKeys() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontExceptionList all public keys that have been added to CloudFront for this account.
- Returns:
- Result of the ListPublicKeys operation returned by the service.
- See Also:
-
listRealtimeLogConfigs
default ListRealtimeLogConfigsResponse listRealtimeLogConfigs(ListRealtimeLogConfigsRequest listRealtimeLogConfigsRequest) throws InvalidArgumentException, AccessDeniedException, NoSuchRealtimeLogConfigException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listRealtimeLogConfigsRequest-- Returns:
- Result of the ListRealtimeLogConfigs operation returned by the service.
- See Also:
-
listRealtimeLogConfigs
default ListRealtimeLogConfigsResponse listRealtimeLogConfigs(Consumer<ListRealtimeLogConfigsRequest.Builder> listRealtimeLogConfigsRequest) throws InvalidArgumentException, AccessDeniedException, NoSuchRealtimeLogConfigException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListRealtimeLogConfigsRequest.Builderavoiding the need to create one manually viaListRealtimeLogConfigsRequest.builder()- Parameters:
listRealtimeLogConfigsRequest- AConsumerthat will call methods onListRealtimeLogConfigsRequest.Builderto create a request.- Returns:
- Result of the ListRealtimeLogConfigs operation returned by the service.
- See Also:
-
listResponseHeadersPolicies
default ListResponseHeadersPoliciesResponse listResponseHeadersPolicies(ListResponseHeadersPoliciesRequest listResponseHeadersPoliciesRequest) throws AccessDeniedException, NoSuchResponseHeadersPolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.- Parameters:
listResponseHeadersPoliciesRequest-- Returns:
- Result of the ListResponseHeadersPolicies operation returned by the service.
- See Also:
-
listResponseHeadersPolicies
default ListResponseHeadersPoliciesResponse listResponseHeadersPolicies(Consumer<ListResponseHeadersPoliciesRequest.Builder> listResponseHeadersPoliciesRequest) throws AccessDeniedException, NoSuchResponseHeadersPolicyException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the
NextMarkervalue from the current response as theMarkervalue in the subsequent request.
This is a convenience which creates an instance of the
ListResponseHeadersPoliciesRequest.Builderavoiding the need to create one manually viaListResponseHeadersPoliciesRequest.builder()- Parameters:
listResponseHeadersPoliciesRequest- AConsumerthat will call methods onListResponseHeadersPoliciesRequest.Builderto create a request.- Returns:
- Result of the ListResponseHeadersPolicies operation returned by the service.
- See Also:
-
listStreamingDistributions
default ListStreamingDistributionsResponse listStreamingDistributions(ListStreamingDistributionsRequest listStreamingDistributionsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException List streaming distributions.
- Parameters:
listStreamingDistributionsRequest- The request to list your streaming distributions.- Returns:
- Result of the ListStreamingDistributions operation returned by the service.
- See Also:
-
listStreamingDistributions
default ListStreamingDistributionsResponse listStreamingDistributions(Consumer<ListStreamingDistributionsRequest.Builder> listStreamingDistributionsRequest) throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException List streaming distributions.
This is a convenience which creates an instance of the
ListStreamingDistributionsRequest.Builderavoiding the need to create one manually viaListStreamingDistributionsRequest.builder()- Parameters:
listStreamingDistributionsRequest- AConsumerthat will call methods onListStreamingDistributionsRequest.Builderto create a request. The request to list your streaming distributions.- Returns:
- Result of the ListStreamingDistributions operation returned by the service.
- See Also:
-
listStreamingDistributions
default ListStreamingDistributionsResponse listStreamingDistributions() throws InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontExceptionList streaming distributions.
- Returns:
- Result of the ListStreamingDistributions operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException List tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
- Parameters:
listTagsForResourceRequest- The request to list tags for a CloudFront resource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException List tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. The request to list tags for a CloudFront resource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
publishFunction
default PublishFunctionResponse publishFunction(PublishFunctionRequest publishFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Publishes a CloudFront function by copying the function code from the
DEVELOPMENTstage toLIVE. This automatically updates all cache behaviors that are using this function to use the newly published copy in theLIVEstage.When a function is published to the
LIVEstage, you can attach the function to a distribution's cache behavior, using the function's Amazon Resource Name (ARN).To publish a function, you must provide the function's name and version (
ETagvalue). To get these values, you can useListFunctionsandDescribeFunction.- Parameters:
publishFunctionRequest-- Returns:
- Result of the PublishFunction operation returned by the service.
- See Also:
-
publishFunction
default PublishFunctionResponse publishFunction(Consumer<PublishFunctionRequest.Builder> publishFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Publishes a CloudFront function by copying the function code from the
DEVELOPMENTstage toLIVE. This automatically updates all cache behaviors that are using this function to use the newly published copy in theLIVEstage.When a function is published to the
LIVEstage, you can attach the function to a distribution's cache behavior, using the function's Amazon Resource Name (ARN).To publish a function, you must provide the function's name and version (
ETagvalue). To get these values, you can useListFunctionsandDescribeFunction.
This is a convenience which creates an instance of the
PublishFunctionRequest.Builderavoiding the need to create one manually viaPublishFunctionRequest.builder()- Parameters:
publishFunctionRequest- AConsumerthat will call methods onPublishFunctionRequest.Builderto create a request.- Returns:
- Result of the PublishFunction operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
- Parameters:
tagResourceRequest- The request to add tags to a CloudFront resource.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request. The request to add tags to a CloudFront resource.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
testFunction
default TestFunctionResponse testFunction(TestFunctionRequest testFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, TestFunctionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function's result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function's name and version (
ETagvalue) along with the event object. To get the function's name and version, you can useListFunctionsandDescribeFunction.- Parameters:
testFunctionRequest-- Returns:
- Result of the TestFunction operation returned by the service.
- See Also:
-
testFunction
default TestFunctionResponse testFunction(Consumer<TestFunctionRequest.Builder> testFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, TestFunctionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function's result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function's name and version (
ETagvalue) along with the event object. To get the function's name and version, you can useListFunctionsandDescribeFunction.
This is a convenience which creates an instance of the
TestFunctionRequest.Builderavoiding the need to create one manually viaTestFunctionRequest.builder()- Parameters:
testFunctionRequest- AConsumerthat will call methods onTestFunctionRequest.Builderto create a request.- Returns:
- Result of the TestFunction operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
- Parameters:
untagResourceRequest- The request to remove tags from a CloudFront resource.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, InvalidArgumentException, InvalidTaggingException, NoSuchResourceException, AwsServiceException, SdkClientException, CloudFrontException Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request. The request to remove tags from a CloudFront resource.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateCachePolicy
default UpdateCachePolicyResponse updateCachePolicy(UpdateCachePolicyRequest updateCachePolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchCachePolicyException, PreconditionFailedException, CachePolicyAlreadyExistsException, TooManyHeadersInCachePolicyException, TooManyCookiesInCachePolicyException, TooManyQueryStringsInCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
-
Use
GetCachePolicyConfigto get the current configuration. -
Locally modify the fields in the cache policy configuration that you want to update.
-
Call
UpdateCachePolicyby providing the entire cache policy configuration, including the fields that you modified and those that you didn't.
- Parameters:
updateCachePolicyRequest-- Returns:
- Result of the UpdateCachePolicy operation returned by the service.
- See Also:
-
-
updateCachePolicy
default UpdateCachePolicyResponse updateCachePolicy(Consumer<UpdateCachePolicyRequest.Builder> updateCachePolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchCachePolicyException, PreconditionFailedException, CachePolicyAlreadyExistsException, TooManyHeadersInCachePolicyException, TooManyCookiesInCachePolicyException, TooManyQueryStringsInCachePolicyException, AwsServiceException, SdkClientException, CloudFrontException Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
-
Use
GetCachePolicyConfigto get the current configuration. -
Locally modify the fields in the cache policy configuration that you want to update.
-
Call
UpdateCachePolicyby providing the entire cache policy configuration, including the fields that you modified and those that you didn't.
This is a convenience which creates an instance of the
UpdateCachePolicyRequest.Builderavoiding the need to create one manually viaUpdateCachePolicyRequest.builder()- Parameters:
updateCachePolicyRequest- AConsumerthat will call methods onUpdateCachePolicyRequest.Builderto create a request.- Returns:
- Result of the UpdateCachePolicy operation returned by the service.
- See Also:
-
-
updateCloudFrontOriginAccessIdentity
default UpdateCloudFrontOriginAccessIdentityResponse updateCloudFrontOriginAccessIdentity(UpdateCloudFrontOriginAccessIdentityRequest updateCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException Update an origin access identity.
- Parameters:
updateCloudFrontOriginAccessIdentityRequest- The request to update an origin access identity.- Returns:
- Result of the UpdateCloudFrontOriginAccessIdentity operation returned by the service.
- See Also:
-
updateCloudFrontOriginAccessIdentity
default UpdateCloudFrontOriginAccessIdentityResponse updateCloudFrontOriginAccessIdentity(Consumer<UpdateCloudFrontOriginAccessIdentityRequest.Builder> updateCloudFrontOriginAccessIdentityRequest) throws AccessDeniedException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchCloudFrontOriginAccessIdentityException, PreconditionFailedException, InvalidArgumentException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException Update an origin access identity.
This is a convenience which creates an instance of the
UpdateCloudFrontOriginAccessIdentityRequest.Builderavoiding the need to create one manually viaUpdateCloudFrontOriginAccessIdentityRequest.builder()- Parameters:
updateCloudFrontOriginAccessIdentityRequest- AConsumerthat will call methods onUpdateCloudFrontOriginAccessIdentityRequest.Builderto create a request. The request to update an origin access identity.- Returns:
- Result of the UpdateCloudFrontOriginAccessIdentity operation returned by the service.
- See Also:
-
updateContinuousDeploymentPolicy
default UpdateContinuousDeploymentPolicyResponse updateContinuousDeploymentPolicy(UpdateContinuousDeploymentPolicyRequest updateContinuousDeploymentPolicyRequest) throws InvalidIfMatchVersionException, InvalidArgumentException, AccessDeniedException, InconsistentQuantitiesException, PreconditionFailedException, StagingDistributionInUseException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.
When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:
-
Use
GetContinuousDeploymentPolicyConfigto get the current configuration. -
Locally modify the fields in the continuous deployment policy configuration that you want to update.
-
Use
UpdateContinuousDeploymentPolicy, providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't.
- Parameters:
updateContinuousDeploymentPolicyRequest-- Returns:
- Result of the UpdateContinuousDeploymentPolicy operation returned by the service.
- See Also:
-
-
updateContinuousDeploymentPolicy
default UpdateContinuousDeploymentPolicyResponse updateContinuousDeploymentPolicy(Consumer<UpdateContinuousDeploymentPolicyRequest.Builder> updateContinuousDeploymentPolicyRequest) throws InvalidIfMatchVersionException, InvalidArgumentException, AccessDeniedException, InconsistentQuantitiesException, PreconditionFailedException, StagingDistributionInUseException, NoSuchContinuousDeploymentPolicyException, AwsServiceException, SdkClientException, CloudFrontException Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.
When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:
-
Use
GetContinuousDeploymentPolicyConfigto get the current configuration. -
Locally modify the fields in the continuous deployment policy configuration that you want to update.
-
Use
UpdateContinuousDeploymentPolicy, providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't.
This is a convenience which creates an instance of the
UpdateContinuousDeploymentPolicyRequest.Builderavoiding the need to create one manually viaUpdateContinuousDeploymentPolicyRequest.builder()- Parameters:
updateContinuousDeploymentPolicyRequest- AConsumerthat will call methods onUpdateContinuousDeploymentPolicyRequest.Builderto create a request.- Returns:
- Result of the UpdateContinuousDeploymentPolicy operation returned by the service.
- See Also:
-
-
updateDistribution
default UpdateDistributionResponse updateDistribution(UpdateDistributionRequest updateDistributionRequest) throws AccessDeniedException, CnameAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchDistributionException, PreconditionFailedException, TooManyDistributionCnamEsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, TooManyDistributionsAssociatedToOriginAccessControlException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, ContinuousDeploymentPolicyInUseException, NoSuchContinuousDeploymentPolicyException, StagingDistributionInUseException, IllegalOriginAccessConfigurationException, InvalidDomainNameForOriginAccessControlException, AwsServiceException, SdkClientException, CloudFrontException Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an
UpdateDistributionrequest to make the updates.To update a web distribution using the CloudFront API
-
Use
GetDistributionConfigto get the current configuration, including the version identifier (ETag). -
Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
-
You must rename the
ETagfield toIfMatch, leaving the value unchanged. (Set the value ofIfMatchto the value ofETag, then remove theETagfield.) -
You can't change the value of
CallerReference.
-
-
Submit an
UpdateDistributionrequest, providing the distribution configuration. The new configuration replaces the existing configuration. The values that you specify in anUpdateDistributionrequest are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't.
- Parameters:
updateDistributionRequest- The request to update a distribution.- Returns:
- Result of the UpdateDistribution operation returned by the service.
- See Also:
-
-
updateDistribution
default UpdateDistributionResponse updateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest) throws AccessDeniedException, CnameAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchDistributionException, PreconditionFailedException, TooManyDistributionCnamEsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, TooManyDistributionsAssociatedToOriginAccessControlException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, ContinuousDeploymentPolicyInUseException, NoSuchContinuousDeploymentPolicyException, StagingDistributionInUseException, IllegalOriginAccessConfigurationException, InvalidDomainNameForOriginAccessControlException, AwsServiceException, SdkClientException, CloudFrontException Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an
UpdateDistributionrequest to make the updates.To update a web distribution using the CloudFront API
-
Use
GetDistributionConfigto get the current configuration, including the version identifier (ETag). -
Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
-
You must rename the
ETagfield toIfMatch, leaving the value unchanged. (Set the value ofIfMatchto the value ofETag, then remove theETagfield.) -
You can't change the value of
CallerReference.
-
-
Submit an
UpdateDistributionrequest, providing the distribution configuration. The new configuration replaces the existing configuration. The values that you specify in anUpdateDistributionrequest are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't.
This is a convenience which creates an instance of the
UpdateDistributionRequest.Builderavoiding the need to create one manually viaUpdateDistributionRequest.builder()- Parameters:
updateDistributionRequest- AConsumerthat will call methods onUpdateDistributionRequest.Builderto create a request. The request to update a distribution.- Returns:
- Result of the UpdateDistribution operation returned by the service.
- See Also:
-
-
updateDistributionWithStagingConfig
default UpdateDistributionWithStagingConfigResponse updateDistributionWithStagingConfig(UpdateDistributionWithStagingConfigRequest updateDistributionWithStagingConfigRequest) throws AccessDeniedException, CnameAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchDistributionException, PreconditionFailedException, TooManyDistributionCnamEsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, TooManyDistributionsAssociatedToOriginAccessControlException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, AwsServiceException, SdkClientException, CloudFrontException Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its
Aliases(also known as alternate domain names or CNAMEs) andContinuousDeploymentPolicyIdvalue, but otherwise its configuration is overwritten to match the staging distribution.You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
- Parameters:
updateDistributionWithStagingConfigRequest-- Returns:
- Result of the UpdateDistributionWithStagingConfig operation returned by the service.
- See Also:
-
updateDistributionWithStagingConfig
default UpdateDistributionWithStagingConfigResponse updateDistributionWithStagingConfig(Consumer<UpdateDistributionWithStagingConfigRequest.Builder> updateDistributionWithStagingConfigRequest) throws AccessDeniedException, CnameAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchDistributionException, PreconditionFailedException, TooManyDistributionCnamEsException, InvalidDefaultRootObjectException, InvalidRelativePathException, InvalidErrorCodeException, InvalidResponseCodeException, InvalidArgumentException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InvalidViewerCertificateException, InvalidMinimumProtocolVersionException, InvalidRequiredProtocolException, NoSuchOriginException, TooManyOriginsException, TooManyOriginGroupsPerDistributionException, TooManyCacheBehaviorsException, TooManyCookieNamesInWhiteListException, InvalidForwardCookiesException, TooManyHeadersInForwardedValuesException, InvalidHeadersForS3OriginException, InconsistentQuantitiesException, TooManyCertificatesException, InvalidLocationCodeException, InvalidGeoRestrictionParameterException, InvalidTtlOrderException, InvalidWebAclIdException, TooManyOriginCustomHeadersException, TooManyQueryStringParametersException, InvalidQueryStringParametersException, TooManyDistributionsWithLambdaAssociationsException, TooManyDistributionsWithSingleFunctionArnException, TooManyLambdaFunctionAssociationsException, InvalidLambdaFunctionAssociationException, TooManyDistributionsWithFunctionAssociationsException, TooManyFunctionAssociationsException, InvalidFunctionAssociationException, InvalidOriginReadTimeoutException, InvalidOriginKeepaliveTimeoutException, NoSuchFieldLevelEncryptionConfigException, IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException, TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException, NoSuchCachePolicyException, TooManyDistributionsAssociatedToCachePolicyException, TooManyDistributionsAssociatedToOriginAccessControlException, NoSuchResponseHeadersPolicyException, TooManyDistributionsAssociatedToResponseHeadersPolicyException, NoSuchOriginRequestPolicyException, TooManyDistributionsAssociatedToOriginRequestPolicyException, TooManyDistributionsAssociatedToKeyGroupException, TooManyKeyGroupsAssociatedToDistributionException, TrustedKeyGroupDoesNotExistException, NoSuchRealtimeLogConfigException, RealtimeLogConfigOwnerMismatchException, AwsServiceException, SdkClientException, CloudFrontException Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its
Aliases(also known as alternate domain names or CNAMEs) andContinuousDeploymentPolicyIdvalue, but otherwise its configuration is overwritten to match the staging distribution.You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
This is a convenience which creates an instance of the
UpdateDistributionWithStagingConfigRequest.Builderavoiding the need to create one manually viaUpdateDistributionWithStagingConfigRequest.builder()- Parameters:
updateDistributionWithStagingConfigRequest- AConsumerthat will call methods onUpdateDistributionWithStagingConfigRequest.Builderto create a request.- Returns:
- Result of the UpdateDistributionWithStagingConfig operation returned by the service.
- See Also:
-
updateFieldLevelEncryptionConfig
default UpdateFieldLevelEncryptionConfigResponse updateFieldLevelEncryptionConfig(UpdateFieldLevelEncryptionConfigRequest updateFieldLevelEncryptionConfigRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionProfileException, NoSuchFieldLevelEncryptionConfigException, PreconditionFailedException, TooManyFieldLevelEncryptionQueryArgProfilesException, TooManyFieldLevelEncryptionContentTypeProfilesException, QueryArgProfileEmptyException, AwsServiceException, SdkClientException, CloudFrontException Update a field-level encryption configuration.
- Parameters:
updateFieldLevelEncryptionConfigRequest-- Returns:
- Result of the UpdateFieldLevelEncryptionConfig operation returned by the service.
- See Also:
-
updateFieldLevelEncryptionConfig
default UpdateFieldLevelEncryptionConfigResponse updateFieldLevelEncryptionConfig(Consumer<UpdateFieldLevelEncryptionConfigRequest.Builder> updateFieldLevelEncryptionConfigRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFieldLevelEncryptionProfileException, NoSuchFieldLevelEncryptionConfigException, PreconditionFailedException, TooManyFieldLevelEncryptionQueryArgProfilesException, TooManyFieldLevelEncryptionContentTypeProfilesException, QueryArgProfileEmptyException, AwsServiceException, SdkClientException, CloudFrontException Update a field-level encryption configuration.
This is a convenience which creates an instance of the
UpdateFieldLevelEncryptionConfigRequest.Builderavoiding the need to create one manually viaUpdateFieldLevelEncryptionConfigRequest.builder()- Parameters:
updateFieldLevelEncryptionConfigRequest- AConsumerthat will call methods onUpdateFieldLevelEncryptionConfigRequest.Builderto create a request.- Returns:
- Result of the UpdateFieldLevelEncryptionConfig operation returned by the service.
- See Also:
-
updateFieldLevelEncryptionProfile
default UpdateFieldLevelEncryptionProfileResponse updateFieldLevelEncryptionProfile(UpdateFieldLevelEncryptionProfileRequest updateFieldLevelEncryptionProfileRequest) throws AccessDeniedException, FieldLevelEncryptionProfileAlreadyExistsException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchPublicKeyException, NoSuchFieldLevelEncryptionProfileException, PreconditionFailedException, FieldLevelEncryptionProfileSizeExceededException, TooManyFieldLevelEncryptionEncryptionEntitiesException, TooManyFieldLevelEncryptionFieldPatternsException, AwsServiceException, SdkClientException, CloudFrontException Update a field-level encryption profile.
- Parameters:
updateFieldLevelEncryptionProfileRequest-- Returns:
- Result of the UpdateFieldLevelEncryptionProfile operation returned by the service.
- See Also:
-
updateFieldLevelEncryptionProfile
default UpdateFieldLevelEncryptionProfileResponse updateFieldLevelEncryptionProfile(Consumer<UpdateFieldLevelEncryptionProfileRequest.Builder> updateFieldLevelEncryptionProfileRequest) throws AccessDeniedException, FieldLevelEncryptionProfileAlreadyExistsException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchPublicKeyException, NoSuchFieldLevelEncryptionProfileException, PreconditionFailedException, FieldLevelEncryptionProfileSizeExceededException, TooManyFieldLevelEncryptionEncryptionEntitiesException, TooManyFieldLevelEncryptionFieldPatternsException, AwsServiceException, SdkClientException, CloudFrontException Update a field-level encryption profile.
This is a convenience which creates an instance of the
UpdateFieldLevelEncryptionProfileRequest.Builderavoiding the need to create one manually viaUpdateFieldLevelEncryptionProfileRequest.builder()- Parameters:
updateFieldLevelEncryptionProfileRequest- AConsumerthat will call methods onUpdateFieldLevelEncryptionProfileRequest.Builderto create a request.- Returns:
- Result of the UpdateFieldLevelEncryptionProfile operation returned by the service.
- See Also:
-
updateFunction
default UpdateFunctionResponse updateFunction(UpdateFunctionRequest updateFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, PreconditionFailedException, FunctionSizeLimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Updates a CloudFront function.
You can update a function's code or the comment that describes the function. You cannot update a function's name.
To update a function, you provide the function's name and version (
ETagvalue) along with the updated function code. To get the name and version, you can useListFunctionsandDescribeFunction.- Parameters:
updateFunctionRequest-- Returns:
- Result of the UpdateFunction operation returned by the service.
- See Also:
-
updateFunction
default UpdateFunctionResponse updateFunction(Consumer<UpdateFunctionRequest.Builder> updateFunctionRequest) throws InvalidArgumentException, InvalidIfMatchVersionException, NoSuchFunctionExistsException, PreconditionFailedException, FunctionSizeLimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Updates a CloudFront function.
You can update a function's code or the comment that describes the function. You cannot update a function's name.
To update a function, you provide the function's name and version (
ETagvalue) along with the updated function code. To get the name and version, you can useListFunctionsandDescribeFunction.
This is a convenience which creates an instance of the
UpdateFunctionRequest.Builderavoiding the need to create one manually viaUpdateFunctionRequest.builder()- Parameters:
updateFunctionRequest- AConsumerthat will call methods onUpdateFunctionRequest.Builderto create a request.- Returns:
- Result of the UpdateFunction operation returned by the service.
- See Also:
-
updateKeyGroup
default UpdateKeyGroupResponse updateKeyGroup(UpdateKeyGroupRequest updateKeyGroupRequest) throws InvalidIfMatchVersionException, NoSuchResourceException, PreconditionFailedException, KeyGroupAlreadyExistsException, InvalidArgumentException, TooManyPublicKeysInKeyGroupException, AwsServiceException, SdkClientException, CloudFrontException Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
-
Get the current key group with
GetKeyGrouporGetKeyGroupConfig. -
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
-
Call
UpdateKeyGroupwith the entire key group object, including the fields that you modified and those that you didn't.
- Parameters:
updateKeyGroupRequest-- Returns:
- Result of the UpdateKeyGroup operation returned by the service.
- See Also:
-
-
updateKeyGroup
default UpdateKeyGroupResponse updateKeyGroup(Consumer<UpdateKeyGroupRequest.Builder> updateKeyGroupRequest) throws InvalidIfMatchVersionException, NoSuchResourceException, PreconditionFailedException, KeyGroupAlreadyExistsException, InvalidArgumentException, TooManyPublicKeysInKeyGroupException, AwsServiceException, SdkClientException, CloudFrontException Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
-
Get the current key group with
GetKeyGrouporGetKeyGroupConfig. -
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
-
Call
UpdateKeyGroupwith the entire key group object, including the fields that you modified and those that you didn't.
This is a convenience which creates an instance of the
UpdateKeyGroupRequest.Builderavoiding the need to create one manually viaUpdateKeyGroupRequest.builder()- Parameters:
updateKeyGroupRequest- AConsumerthat will call methods onUpdateKeyGroupRequest.Builderto create a request.- Returns:
- Result of the UpdateKeyGroup operation returned by the service.
- See Also:
-
-
updateKeyValueStore
default UpdateKeyValueStoreResponse updateKeyValueStore(UpdateKeyValueStoreRequest updateKeyValueStoreRequest) throws AccessDeniedException, InvalidArgumentException, EntityNotFoundException, InvalidIfMatchVersionException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value store to update.
- Parameters:
updateKeyValueStoreRequest-- Returns:
- Result of the UpdateKeyValueStore operation returned by the service.
- See Also:
-
updateKeyValueStore
default UpdateKeyValueStoreResponse updateKeyValueStore(Consumer<UpdateKeyValueStoreRequest.Builder> updateKeyValueStoreRequest) throws AccessDeniedException, InvalidArgumentException, EntityNotFoundException, InvalidIfMatchVersionException, PreconditionFailedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudFrontException Specifies the key value store to update.
This is a convenience which creates an instance of the
UpdateKeyValueStoreRequest.Builderavoiding the need to create one manually viaUpdateKeyValueStoreRequest.builder()- Parameters:
updateKeyValueStoreRequest- AConsumerthat will call methods onUpdateKeyValueStoreRequest.Builderto create a request.- Returns:
- Result of the UpdateKeyValueStore operation returned by the service.
- See Also:
-
updateOriginAccessControl
default UpdateOriginAccessControlResponse updateOriginAccessControl(UpdateOriginAccessControlRequest updateOriginAccessControlRequest) throws AccessDeniedException, IllegalUpdateException, InvalidIfMatchVersionException, OriginAccessControlAlreadyExistsException, NoSuchOriginAccessControlException, PreconditionFailedException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Updates a CloudFront origin access control.
- Parameters:
updateOriginAccessControlRequest-- Returns:
- Result of the UpdateOriginAccessControl operation returned by the service.
- See Also:
-
updateOriginAccessControl
default UpdateOriginAccessControlResponse updateOriginAccessControl(Consumer<UpdateOriginAccessControlRequest.Builder> updateOriginAccessControlRequest) throws AccessDeniedException, IllegalUpdateException, InvalidIfMatchVersionException, OriginAccessControlAlreadyExistsException, NoSuchOriginAccessControlException, PreconditionFailedException, InvalidArgumentException, AwsServiceException, SdkClientException, CloudFrontException Updates a CloudFront origin access control.
This is a convenience which creates an instance of the
UpdateOriginAccessControlRequest.Builderavoiding the need to create one manually viaUpdateOriginAccessControlRequest.builder()- Parameters:
updateOriginAccessControlRequest- AConsumerthat will call methods onUpdateOriginAccessControlRequest.Builderto create a request.- Returns:
- Result of the UpdateOriginAccessControl operation returned by the service.
- See Also:
-
updateOriginRequestPolicy
default UpdateOriginRequestPolicyResponse updateOriginRequestPolicy(UpdateOriginRequestPolicyRequest updateOriginRequestPolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchOriginRequestPolicyException, PreconditionFailedException, OriginRequestPolicyAlreadyExistsException, TooManyHeadersInOriginRequestPolicyException, TooManyCookiesInOriginRequestPolicyException, TooManyQueryStringsInOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
-
Use
GetOriginRequestPolicyConfigto get the current configuration. -
Locally modify the fields in the origin request policy configuration that you want to update.
-
Call
UpdateOriginRequestPolicyby providing the entire origin request policy configuration, including the fields that you modified and those that you didn't.
- Parameters:
updateOriginRequestPolicyRequest-- Returns:
- Result of the UpdateOriginRequestPolicy operation returned by the service.
- See Also:
-
-
updateOriginRequestPolicy
default UpdateOriginRequestPolicyResponse updateOriginRequestPolicy(Consumer<UpdateOriginRequestPolicyRequest.Builder> updateOriginRequestPolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchOriginRequestPolicyException, PreconditionFailedException, OriginRequestPolicyAlreadyExistsException, TooManyHeadersInOriginRequestPolicyException, TooManyCookiesInOriginRequestPolicyException, TooManyQueryStringsInOriginRequestPolicyException, AwsServiceException, SdkClientException, CloudFrontException Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
-
Use
GetOriginRequestPolicyConfigto get the current configuration. -
Locally modify the fields in the origin request policy configuration that you want to update.
-
Call
UpdateOriginRequestPolicyby providing the entire origin request policy configuration, including the fields that you modified and those that you didn't.
This is a convenience which creates an instance of the
UpdateOriginRequestPolicyRequest.Builderavoiding the need to create one manually viaUpdateOriginRequestPolicyRequest.builder()- Parameters:
updateOriginRequestPolicyRequest- AConsumerthat will call methods onUpdateOriginRequestPolicyRequest.Builderto create a request.- Returns:
- Result of the UpdateOriginRequestPolicy operation returned by the service.
- See Also:
-
-
updatePublicKey
default UpdatePublicKeyResponse updatePublicKey(UpdatePublicKeyRequest updatePublicKeyRequest) throws AccessDeniedException, CannotChangeImmutablePublicKeyFieldsException, InvalidArgumentException, InvalidIfMatchVersionException, IllegalUpdateException, NoSuchPublicKeyException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException Update public key information. Note that the only value you can change is the comment.
- Parameters:
updatePublicKeyRequest-- Returns:
- Result of the UpdatePublicKey operation returned by the service.
- See Also:
-
updatePublicKey
default UpdatePublicKeyResponse updatePublicKey(Consumer<UpdatePublicKeyRequest.Builder> updatePublicKeyRequest) throws AccessDeniedException, CannotChangeImmutablePublicKeyFieldsException, InvalidArgumentException, InvalidIfMatchVersionException, IllegalUpdateException, NoSuchPublicKeyException, PreconditionFailedException, AwsServiceException, SdkClientException, CloudFrontException Update public key information. Note that the only value you can change is the comment.
This is a convenience which creates an instance of the
UpdatePublicKeyRequest.Builderavoiding the need to create one manually viaUpdatePublicKeyRequest.builder()- Parameters:
updatePublicKeyRequest- AConsumerthat will call methods onUpdatePublicKeyRequest.Builderto create a request.- Returns:
- Result of the UpdatePublicKey operation returned by the service.
- See Also:
-
updateRealtimeLogConfig
default UpdateRealtimeLogConfigResponse updateRealtimeLogConfig(UpdateRealtimeLogConfigRequest updateRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
-
Call
GetRealtimeLogConfigto get the current real-time log configuration. -
Locally modify the parameters in the real-time log configuration that you want to update.
-
Call this API (
UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn't.
You cannot update a real-time log configuration's
NameorARN.- Parameters:
updateRealtimeLogConfigRequest-- Returns:
- Result of the UpdateRealtimeLogConfig operation returned by the service.
- See Also:
-
-
updateRealtimeLogConfig
default UpdateRealtimeLogConfigResponse updateRealtimeLogConfig(Consumer<UpdateRealtimeLogConfigRequest.Builder> updateRealtimeLogConfigRequest) throws NoSuchRealtimeLogConfigException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, CloudFrontException Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
-
Call
GetRealtimeLogConfigto get the current real-time log configuration. -
Locally modify the parameters in the real-time log configuration that you want to update.
-
Call this API (
UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn't.
You cannot update a real-time log configuration's
NameorARN.
This is a convenience which creates an instance of the
UpdateRealtimeLogConfigRequest.Builderavoiding the need to create one manually viaUpdateRealtimeLogConfigRequest.builder()- Parameters:
updateRealtimeLogConfigRequest- AConsumerthat will call methods onUpdateRealtimeLogConfigRequest.Builderto create a request.- Returns:
- Result of the UpdateRealtimeLogConfig operation returned by the service.
- See Also:
-
-
updateResponseHeadersPolicy
default UpdateResponseHeadersPolicyResponse updateResponseHeadersPolicy(UpdateResponseHeadersPolicyRequest updateResponseHeadersPolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchResponseHeadersPolicyException, PreconditionFailedException, ResponseHeadersPolicyAlreadyExistsException, TooManyCustomHeadersInResponseHeadersPolicyException, TooLongCspInResponseHeadersPolicyException, TooManyRemoveHeadersInResponseHeadersPolicyException, AwsServiceException, SdkClientException, CloudFrontException Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
-
Use
GetResponseHeadersPolicyConfigto get the current policy's configuration. -
Modify the fields in the response headers policy configuration that you want to update.
-
Call
UpdateResponseHeadersPolicy, providing the entire response headers policy configuration, including the fields that you modified and those that you didn't.
- Parameters:
updateResponseHeadersPolicyRequest-- Returns:
- Result of the UpdateResponseHeadersPolicy operation returned by the service.
- See Also:
-
-
updateResponseHeadersPolicy
default UpdateResponseHeadersPolicyResponse updateResponseHeadersPolicy(Consumer<UpdateResponseHeadersPolicyRequest.Builder> updateResponseHeadersPolicyRequest) throws AccessDeniedException, IllegalUpdateException, InconsistentQuantitiesException, InvalidArgumentException, InvalidIfMatchVersionException, NoSuchResponseHeadersPolicyException, PreconditionFailedException, ResponseHeadersPolicyAlreadyExistsException, TooManyCustomHeadersInResponseHeadersPolicyException, TooLongCspInResponseHeadersPolicyException, TooManyRemoveHeadersInResponseHeadersPolicyException, AwsServiceException, SdkClientException, CloudFrontException Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
-
Use
GetResponseHeadersPolicyConfigto get the current policy's configuration. -
Modify the fields in the response headers policy configuration that you want to update.
-
Call
UpdateResponseHeadersPolicy, providing the entire response headers policy configuration, including the fields that you modified and those that you didn't.
This is a convenience which creates an instance of the
UpdateResponseHeadersPolicyRequest.Builderavoiding the need to create one manually viaUpdateResponseHeadersPolicyRequest.builder()- Parameters:
updateResponseHeadersPolicyRequest- AConsumerthat will call methods onUpdateResponseHeadersPolicyRequest.Builderto create a request.- Returns:
- Result of the UpdateResponseHeadersPolicy operation returned by the service.
- See Also:
-
-
updateStreamingDistribution
default UpdateStreamingDistributionResponse updateStreamingDistribution(UpdateStreamingDistributionRequest updateStreamingDistributionRequest) throws AccessDeniedException, CnameAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchStreamingDistributionException, PreconditionFailedException, TooManyStreamingDistributionCnamEsException, InvalidArgumentException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException Update a streaming distribution.
- Parameters:
updateStreamingDistributionRequest- The request to update a streaming distribution.- Returns:
- Result of the UpdateStreamingDistribution operation returned by the service.
- See Also:
-
updateStreamingDistribution
default UpdateStreamingDistributionResponse updateStreamingDistribution(Consumer<UpdateStreamingDistributionRequest.Builder> updateStreamingDistributionRequest) throws AccessDeniedException, CnameAlreadyExistsException, IllegalUpdateException, InvalidIfMatchVersionException, MissingBodyException, NoSuchStreamingDistributionException, PreconditionFailedException, TooManyStreamingDistributionCnamEsException, InvalidArgumentException, InvalidOriginAccessIdentityException, InvalidOriginAccessControlException, TooManyTrustedSignersException, TrustedSignerDoesNotExistException, InconsistentQuantitiesException, AwsServiceException, SdkClientException, CloudFrontException Update a streaming distribution.
This is a convenience which creates an instance of the
UpdateStreamingDistributionRequest.Builderavoiding the need to create one manually viaUpdateStreamingDistributionRequest.builder()- Parameters:
updateStreamingDistributionRequest- AConsumerthat will call methods onUpdateStreamingDistributionRequest.Builderto create a request. The request to update a streaming distribution.- Returns:
- Result of the UpdateStreamingDistribution operation returned by the service.
- See Also:
-
utilities
Creates an instance ofCloudFrontUtilitiesobject with the configuration set on this client. -
waiter
Create an instance ofCloudFrontWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
CloudFrontWaiter
-
create
Create aCloudFrontClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aCloudFrontClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-