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 String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AssociateAliasResponse
associateAlias
(Consumer<AssociateAliasRequest.Builder> associateAliasRequest) Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.default AssociateAliasResponse
associateAlias
(AssociateAliasRequest associateAliasRequest) Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.static CloudFrontClientBuilder
builder()
Create a builder that can be used to configure and create aCloudFrontClient
.default CopyDistributionResponse
copyDistribution
(Consumer<CopyDistributionRequest.Builder> copyDistributionRequest) Creates a staging distribution using the configuration of the provided primary distribution.default CopyDistributionResponse
copyDistribution
(CopyDistributionRequest copyDistributionRequest) Creates a staging distribution using the configuration of the provided primary distribution.static CloudFrontClient
create()
Create aCloudFrontClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateCachePolicyResponse
createCachePolicy
(Consumer<CreateCachePolicyRequest.Builder> createCachePolicyRequest) Creates a cache policy.default CreateCachePolicyResponse
createCachePolicy
(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 CreateDistributionResponse
createDistribution
(Consumer<CreateDistributionRequest.Builder> createDistributionRequest) Creates a CloudFront distribution.default CreateDistributionResponse
createDistribution
(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 CreateFunctionResponse
createFunction
(Consumer<CreateFunctionRequest.Builder> createFunctionRequest) Creates a CloudFront function.default CreateFunctionResponse
createFunction
(CreateFunctionRequest createFunctionRequest) Creates a CloudFront function.default CreateInvalidationResponse
createInvalidation
(Consumer<CreateInvalidationRequest.Builder> createInvalidationRequest) Create a new invalidation.default CreateInvalidationResponse
createInvalidation
(CreateInvalidationRequest createInvalidationRequest) Create a new invalidation.default CreateKeyGroupResponse
createKeyGroup
(Consumer<CreateKeyGroupRequest.Builder> createKeyGroupRequest) Creates a key group that you can use with CloudFront signed URLs and signed cookies.default CreateKeyGroupResponse
createKeyGroup
(CreateKeyGroupRequest createKeyGroupRequest) Creates a key group that you can use with CloudFront signed URLs and signed cookies.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 CreatePublicKeyResponse
createPublicKey
(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 CreatePublicKeyResponse
createPublicKey
(CreatePublicKeyRequest createPublicKeyRequest) Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.default CreateRealtimeLogConfigResponse
createRealtimeLogConfig
(Consumer<CreateRealtimeLogConfigRequest.Builder> createRealtimeLogConfigRequest) Creates a real-time log configuration.default CreateRealtimeLogConfigResponse
createRealtimeLogConfig
(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 DeleteCachePolicyResponse
deleteCachePolicy
(Consumer<DeleteCachePolicyRequest.Builder> deleteCachePolicyRequest) Deletes a cache policy.default DeleteCachePolicyResponse
deleteCachePolicy
(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 DeleteDistributionResponse
deleteDistribution
(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest) Delete a distribution.default DeleteDistributionResponse
deleteDistribution
(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 DeleteFunctionResponse
deleteFunction
(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest) Deletes a CloudFront function.default DeleteFunctionResponse
deleteFunction
(DeleteFunctionRequest deleteFunctionRequest) Deletes a CloudFront function.default DeleteKeyGroupResponse
deleteKeyGroup
(Consumer<DeleteKeyGroupRequest.Builder> deleteKeyGroupRequest) Deletes a key group.default DeleteKeyGroupResponse
deleteKeyGroup
(DeleteKeyGroupRequest deleteKeyGroupRequest) Deletes a key group.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 DeletePublicKeyResponse
deletePublicKey
(Consumer<DeletePublicKeyRequest.Builder> deletePublicKeyRequest) Remove a public key you previously added to CloudFront.default DeletePublicKeyResponse
deletePublicKey
(DeletePublicKeyRequest deletePublicKeyRequest) Remove a public key you previously added to CloudFront.default DeleteRealtimeLogConfigResponse
deleteRealtimeLogConfig
(Consumer<DeleteRealtimeLogConfigRequest.Builder> deleteRealtimeLogConfigRequest) Deletes a real-time log configuration.default DeleteRealtimeLogConfigResponse
deleteRealtimeLogConfig
(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 DescribeFunctionResponse
describeFunction
(Consumer<DescribeFunctionRequest.Builder> describeFunctionRequest) Gets configuration information and metadata about a CloudFront function, but not the function's code.default DescribeFunctionResponse
describeFunction
(DescribeFunctionRequest describeFunctionRequest) Gets configuration information and metadata about a CloudFront function, but not the function's code.default GetCachePolicyResponse
getCachePolicy
(Consumer<GetCachePolicyRequest.Builder> getCachePolicyRequest) Gets a cache policy, including the following metadata:default GetCachePolicyResponse
getCachePolicy
(GetCachePolicyRequest getCachePolicyRequest) Gets a cache policy, including the following metadata:default GetCachePolicyConfigResponse
getCachePolicyConfig
(Consumer<GetCachePolicyConfigRequest.Builder> getCachePolicyConfigRequest) Gets a cache policy configuration.default GetCachePolicyConfigResponse
getCachePolicyConfig
(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 GetDistributionResponse
getDistribution
(Consumer<GetDistributionRequest.Builder> getDistributionRequest) Get the information about a distribution.default GetDistributionResponse
getDistribution
(GetDistributionRequest getDistributionRequest) Get the information about a distribution.default GetDistributionConfigResponse
getDistributionConfig
(Consumer<GetDistributionConfigRequest.Builder> getDistributionConfigRequest) Get the configuration information about a distribution.default GetDistributionConfigResponse
getDistributionConfig
(GetDistributionConfigRequest getDistributionConfigRequest) Get the configuration information about a distribution.default GetFieldLevelEncryptionResponse
getFieldLevelEncryption
(Consumer<GetFieldLevelEncryptionRequest.Builder> getFieldLevelEncryptionRequest) Get the field-level encryption configuration information.default GetFieldLevelEncryptionResponse
getFieldLevelEncryption
(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 GetFunctionResponse
getFunction
(Consumer<GetFunctionRequest.Builder> getFunctionRequest) Gets the code of a CloudFront function.default GetFunctionResponse
getFunction
(GetFunctionRequest getFunctionRequest) Gets the code of a CloudFront function.default GetInvalidationResponse
getInvalidation
(Consumer<GetInvalidationRequest.Builder> getInvalidationRequest) Get the information about an invalidation.default GetInvalidationResponse
getInvalidation
(GetInvalidationRequest getInvalidationRequest) Get the information about an invalidation.default GetKeyGroupResponse
getKeyGroup
(Consumer<GetKeyGroupRequest.Builder> getKeyGroupRequest) Gets a key group, including the date and time when the key group was last modified.default GetKeyGroupResponse
getKeyGroup
(GetKeyGroupRequest getKeyGroupRequest) Gets a key group, including the date and time when the key group was last modified.default GetKeyGroupConfigResponse
getKeyGroupConfig
(Consumer<GetKeyGroupConfigRequest.Builder> getKeyGroupConfigRequest) Gets a key group configuration.default GetKeyGroupConfigResponse
getKeyGroupConfig
(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 GetOriginAccessControlResponse
getOriginAccessControl
(Consumer<GetOriginAccessControlRequest.Builder> getOriginAccessControlRequest) Gets a CloudFront origin access control, including its unique identifier.default GetOriginAccessControlResponse
getOriginAccessControl
(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 GetOriginRequestPolicyResponse
getOriginRequestPolicy
(Consumer<GetOriginRequestPolicyRequest.Builder> getOriginRequestPolicyRequest) Gets an origin request policy, including the following metadata:default GetOriginRequestPolicyResponse
getOriginRequestPolicy
(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 GetPublicKeyResponse
getPublicKey
(Consumer<GetPublicKeyRequest.Builder> getPublicKeyRequest) Gets a public key.default GetPublicKeyResponse
getPublicKey
(GetPublicKeyRequest getPublicKeyRequest) Gets a public key.default GetPublicKeyConfigResponse
getPublicKeyConfig
(Consumer<GetPublicKeyConfigRequest.Builder> getPublicKeyConfigRequest) Gets a public key configuration.default GetPublicKeyConfigResponse
getPublicKeyConfig
(GetPublicKeyConfigRequest getPublicKeyConfigRequest) Gets a public key configuration.default GetRealtimeLogConfigResponse
getRealtimeLogConfig
(Consumer<GetRealtimeLogConfigRequest.Builder> getRealtimeLogConfigRequest) Gets a real-time log configuration.default GetRealtimeLogConfigResponse
getRealtimeLogConfig
(GetRealtimeLogConfigRequest getRealtimeLogConfigRequest) Gets a real-time log configuration.default GetResponseHeadersPolicyResponse
getResponseHeadersPolicy
(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 GetResponseHeadersPolicyResponse
getResponseHeadersPolicy
(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 GetStreamingDistributionResponse
getStreamingDistribution
(Consumer<GetStreamingDistributionRequest.Builder> getStreamingDistributionRequest) Gets information about a specified RTMP distribution, including the distribution configuration.default GetStreamingDistributionResponse
getStreamingDistribution
(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 ListCachePoliciesResponse
listCachePolicies
(Consumer<ListCachePoliciesRequest.Builder> listCachePoliciesRequest) Gets a list of cache policies.default ListCachePoliciesResponse
listCachePolicies
(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 ListConflictingAliasesResponse
listConflictingAliases
(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 ListConflictingAliasesResponse
listConflictingAliases
(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 ListDistributionsResponse
List CloudFront distributions.default ListDistributionsResponse
listDistributions
(Consumer<ListDistributionsRequest.Builder> listDistributionsRequest) List CloudFront distributions.default ListDistributionsResponse
listDistributions
(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 ListFunctionsResponse
listFunctions
(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest) Gets a list of all CloudFront functions in your Amazon Web Services account.default ListFunctionsResponse
listFunctions
(ListFunctionsRequest listFunctionsRequest) Gets a list of all CloudFront functions in your Amazon Web Services account.default ListInvalidationsResponse
listInvalidations
(Consumer<ListInvalidationsRequest.Builder> listInvalidationsRequest) Lists invalidation batches.default ListInvalidationsResponse
listInvalidations
(ListInvalidationsRequest listInvalidationsRequest) Lists invalidation batches.default ListKeyGroupsResponse
listKeyGroups
(Consumer<ListKeyGroupsRequest.Builder> listKeyGroupsRequest) Gets a list of key groups.default ListKeyGroupsResponse
listKeyGroups
(ListKeyGroupsRequest listKeyGroupsRequest) Gets a list of key groups.default ListOriginAccessControlsResponse
listOriginAccessControls
(Consumer<ListOriginAccessControlsRequest.Builder> listOriginAccessControlsRequest) Gets the list of CloudFront origin access controls in this Amazon Web Services account.default ListOriginAccessControlsResponse
listOriginAccessControls
(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 ListPublicKeysResponse
List all public keys that have been added to CloudFront for this account.default ListPublicKeysResponse
listPublicKeys
(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) List all public keys that have been added to CloudFront for this account.default ListPublicKeysResponse
listPublicKeys
(ListPublicKeysRequest listPublicKeysRequest) List all public keys that have been added to CloudFront for this account.default ListRealtimeLogConfigsResponse
listRealtimeLogConfigs
(Consumer<ListRealtimeLogConfigsRequest.Builder> listRealtimeLogConfigsRequest) Gets a list of real-time log configurations.default ListRealtimeLogConfigsResponse
listRealtimeLogConfigs
(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 ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List tags for a CloudFront resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List tags for a CloudFront resource.default PublishFunctionResponse
publishFunction
(Consumer<PublishFunctionRequest.Builder> publishFunctionRequest) Publishes a CloudFront function by copying the function code from theDEVELOPMENT
stage toLIVE
.default PublishFunctionResponse
publishFunction
(PublishFunctionRequest publishFunctionRequest) Publishes a CloudFront function by copying the function code from theDEVELOPMENT
stage toLIVE
.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add tags to a CloudFront resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Add tags to a CloudFront resource.default TestFunctionResponse
testFunction
(Consumer<TestFunctionRequest.Builder> testFunctionRequest) Tests a CloudFront function.default TestFunctionResponse
testFunction
(TestFunctionRequest testFunctionRequest) Tests a CloudFront function.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from a CloudFront resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Remove tags from a CloudFront resource.default UpdateCachePolicyResponse
updateCachePolicy
(Consumer<UpdateCachePolicyRequest.Builder> updateCachePolicyRequest) Updates a cache policy configuration.default UpdateCachePolicyResponse
updateCachePolicy
(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 UpdateDistributionResponse
updateDistribution
(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest) Updates the configuration for a CloudFront distribution.default UpdateDistributionResponse
updateDistribution
(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 UpdateFunctionResponse
updateFunction
(Consumer<UpdateFunctionRequest.Builder> updateFunctionRequest) Updates a CloudFront function.default UpdateFunctionResponse
updateFunction
(UpdateFunctionRequest updateFunctionRequest) Updates a CloudFront function.default UpdateKeyGroupResponse
updateKeyGroup
(Consumer<UpdateKeyGroupRequest.Builder> updateKeyGroupRequest) Updates a key group.default UpdateKeyGroupResponse
updateKeyGroup
(UpdateKeyGroupRequest updateKeyGroupRequest) Updates a key group.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 UpdatePublicKeyResponse
updatePublicKey
(Consumer<UpdatePublicKeyRequest.Builder> updatePublicKeyRequest) Update public key information.default UpdatePublicKeyResponse
updatePublicKey
(UpdatePublicKeyRequest updatePublicKeyRequest) Update public key information.default UpdateRealtimeLogConfigResponse
updateRealtimeLogConfig
(Consumer<UpdateRealtimeLogConfigRequest.Builder> updateRealtimeLogConfigRequest) Updates a real-time log configuration.default UpdateRealtimeLogConfigResponse
updateRealtimeLogConfig
(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 CloudFrontUtilities
Creates an instance ofCloudFrontUtilities
object with the configuration set on this client.default CloudFrontWaiter
waiter()
Create an instance ofCloudFrontWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods 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.Builder
avoiding the need to create one manually viaAssociateAliasRequest.builder()
- Parameters:
associateAliasRequest
- AConsumer
that will call methods onAssociateAliasRequest.Builder
to 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
UpdateDistribution
to modify the staging distribution's configuration. Then you can useCreateContinuousDeploymentPolicy
to 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
UpdateDistribution
to modify the staging distribution's configuration. Then you can useCreateContinuousDeploymentPolicy
to 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.Builder
avoiding the need to create one manually viaCopyDistributionRequest.builder()
- Parameters:
copyDistributionRequest
- AConsumer
that will call methods onCopyDistributionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateCachePolicyRequest.builder()
- Parameters:
createCachePolicyRequest
- AConsumer
that will call methods onCreateCachePolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateCloudFrontOriginAccessIdentityRequest.builder()
- Parameters:
createCloudFrontOriginAccessIdentityRequest
- AConsumer
that will call methods onCreateCloudFrontOriginAccessIdentityRequest.Builder
to 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
CopyDistribution
to create a staging distribution, then useUpdateDistribution
to 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
CopyDistribution
to create a staging distribution, then useUpdateDistribution
to 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.Builder
avoiding the need to create one manually viaCreateContinuousDeploymentPolicyRequest.builder()
- Parameters:
createContinuousDeploymentPolicyRequest
- AConsumer
that will call methods onCreateContinuousDeploymentPolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateDistributionRequest.builder()
- Parameters:
createDistributionRequest
- AConsumer
that will call methods onCreateDistributionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateDistributionWithTagsRequest.builder()
- Parameters:
createDistributionWithTagsRequest
- AConsumer
that will call methods onCreateDistributionWithTagsRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateFieldLevelEncryptionConfigRequest.builder()
- Parameters:
createFieldLevelEncryptionConfigRequest
- AConsumer
that will call methods onCreateFieldLevelEncryptionConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateFieldLevelEncryptionProfileRequest.builder()
- Parameters:
createFieldLevelEncryptionProfileRequest
- AConsumer
that will call methods onCreateFieldLevelEncryptionProfileRequest.Builder
to 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
DEVELOPMENT
stage. 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
PublishFunction
to copy the function from theDEVELOPMENT
stage 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
DEVELOPMENT
stage. 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
PublishFunction
to copy the function from theDEVELOPMENT
stage 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.Builder
avoiding the need to create one manually viaCreateFunctionRequest.builder()
- Parameters:
createFunctionRequest
- AConsumer
that will call methods onCreateFunctionRequest.Builder
to 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.
- 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.
This is a convenience which creates an instance of the
CreateInvalidationRequest.Builder
avoiding the need to create one manually viaCreateInvalidationRequest.builder()
- Parameters:
createInvalidationRequest
- AConsumer
that will call methods onCreateInvalidationRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateKeyGroupRequest.builder()
- Parameters:
createKeyGroupRequest
- AConsumer
that will call methods onCreateKeyGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateKeyGroup 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.Builder
avoiding the need to create one manually viaCreateMonitoringSubscriptionRequest.builder()
- Parameters:
createMonitoringSubscriptionRequest
- AConsumer
that will call methods onCreateMonitoringSubscriptionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateOriginAccessControlRequest.builder()
- Parameters:
createOriginAccessControlRequest
- AConsumer
that will call methods onCreateOriginAccessControlRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateOriginRequestPolicyRequest.builder()
- Parameters:
createOriginRequestPolicyRequest
- AConsumer
that will call methods onCreateOriginRequestPolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreatePublicKeyRequest.builder()
- Parameters:
createPublicKeyRequest
- AConsumer
that will call methods onCreatePublicKeyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateRealtimeLogConfigRequest.builder()
- Parameters:
createRealtimeLogConfigRequest
- AConsumer
that will call methods onCreateRealtimeLogConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateResponseHeadersPolicyRequest.builder()
- Parameters:
createResponseHeadersPolicyRequest
- AConsumer
that will call methods onCreateResponseHeadersPolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateStreamingDistributionRequest.builder()
- Parameters:
createStreamingDistributionRequest
- AConsumer
that will call methods onCreateStreamingDistributionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaCreateStreamingDistributionWithTagsRequest.builder()
- Parameters:
createStreamingDistributionWithTagsRequest
- AConsumer
that will call methods onCreateStreamingDistributionWithTagsRequest.Builder
to 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
ListCachePolicies
orGetCachePolicy
.- 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
ListCachePolicies
orGetCachePolicy
.
This is a convenience which creates an instance of the
DeleteCachePolicyRequest.Builder
avoiding the need to create one manually viaDeleteCachePolicyRequest.builder()
- Parameters:
deleteCachePolicyRequest
- AConsumer
that will call methods onDeleteCachePolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaDeleteCloudFrontOriginAccessIdentityRequest.builder()
- Parameters:
deleteCloudFrontOriginAccessIdentityRequest
- AConsumer
that will call methods onDeleteCloudFrontOriginAccessIdentityRequest.Builder
to 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.Builder
avoiding the need to create one manually viaDeleteContinuousDeploymentPolicyRequest.builder()
- Parameters:
deleteContinuousDeploymentPolicyRequest
- AConsumer
that will call methods onDeleteContinuousDeploymentPolicyRequest.Builder
to 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 Config
request to get the current configuration and theEtag
header for the distribution. -
Update the XML document that was returned in the response to your
GET Distribution Config
request to change the value ofEnabled
tofalse
. -
Submit a
PUT Distribution Config
request 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-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Distribution Config
request in Step 2. -
Review the response to the
PUT Distribution Config
request to confirm that the distribution was successfully disabled. -
Submit a
GET Distribution
request to confirm that your changes have propagated. When propagation is complete, the value ofStatus
isDeployed
. -
Submit a
DELETE Distribution
request. Set the value of the HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Distribution Config
request in Step 6. -
Review the response to your
DELETE Distribution
request 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.Builder
avoiding the need to create one manually viaDeleteDistributionRequest.builder()
- Parameters:
deleteDistributionRequest
- AConsumer
that will call methods onDeleteDistributionRequest.Builder
to 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 Config
request to get the current configuration and theEtag
header for the distribution. -
Update the XML document that was returned in the response to your
GET Distribution Config
request to change the value ofEnabled
tofalse
. -
Submit a
PUT Distribution Config
request 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-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Distribution Config
request in Step 2. -
Review the response to the
PUT Distribution Config
request to confirm that the distribution was successfully disabled. -
Submit a
GET Distribution
request to confirm that your changes have propagated. When propagation is complete, the value ofStatus
isDeployed
. -
Submit a
DELETE Distribution
request. Set the value of the HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Distribution Config
request in Step 6. -
Review the response to your
DELETE Distribution
request 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.Builder
avoiding the need to create one manually viaDeleteFieldLevelEncryptionConfigRequest.builder()
- Parameters:
deleteFieldLevelEncryptionConfigRequest
- AConsumer
that will call methods onDeleteFieldLevelEncryptionConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaDeleteFieldLevelEncryptionProfileRequest.builder()
- Parameters:
deleteFieldLevelEncryptionProfileRequest
- AConsumer
that will call methods onDeleteFieldLevelEncryptionProfileRequest.Builder
to 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 (
ETag
value). To get these values, you can useListFunctions
andDescribeFunction
.- 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 (
ETag
value). To get these values, you can useListFunctions
andDescribeFunction
.
This is a convenience which creates an instance of the
DeleteFunctionRequest.Builder
avoiding the need to create one manually viaDeleteFunctionRequest.builder()
- Parameters:
deleteFunctionRequest
- AConsumer
that will call methods onDeleteFunctionRequest.Builder
to 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
ListKeyGroups
followed byGetKeyGroup
orGetKeyGroupConfig
.- 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
ListKeyGroups
followed byGetKeyGroup
orGetKeyGroupConfig
.
This is a convenience which creates an instance of the
DeleteKeyGroupRequest.Builder
avoiding the need to create one manually viaDeleteKeyGroupRequest.builder()
- Parameters:
deleteKeyGroupRequest
- AConsumer
that will call methods onDeleteKeyGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteKeyGroup 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.Builder
avoiding the need to create one manually viaDeleteMonitoringSubscriptionRequest.builder()
- Parameters:
deleteMonitoringSubscriptionRequest
- AConsumer
that will call methods onDeleteMonitoringSubscriptionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaDeleteOriginAccessControlRequest.builder()
- Parameters:
deleteOriginAccessControlRequest
- AConsumer
that will call methods onDeleteOriginAccessControlRequest.Builder
to 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
ListOriginRequestPolicies
orGetOriginRequestPolicy
.- 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
ListOriginRequestPolicies
orGetOriginRequestPolicy
.
This is a convenience which creates an instance of the
DeleteOriginRequestPolicyRequest.Builder
avoiding the need to create one manually viaDeleteOriginRequestPolicyRequest.builder()
- Parameters:
deleteOriginRequestPolicyRequest
- AConsumer
that will call methods onDeleteOriginRequestPolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaDeletePublicKeyRequest.builder()
- Parameters:
deletePublicKeyRequest
- AConsumer
that will call methods onDeletePublicKeyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaDeleteRealtimeLogConfigRequest.builder()
- Parameters:
deleteRealtimeLogConfigRequest
- AConsumer
that will call methods onDeleteRealtimeLogConfigRequest.Builder
to 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
ListResponseHeadersPolicies
orGetResponseHeadersPolicy
.- 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
ListResponseHeadersPolicies
orGetResponseHeadersPolicy
.
This is a convenience which creates an instance of the
DeleteResponseHeadersPolicyRequest.Builder
avoiding the need to create one manually viaDeleteResponseHeadersPolicyRequest.builder()
- Parameters:
deleteResponseHeadersPolicyRequest
- AConsumer
that will call methods onDeleteResponseHeadersPolicyRequest.Builder
to 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 Config
request to get the current configuration and theEtag
header for the distribution. -
Update the XML document that was returned in the response to your
GET Streaming Distribution Config
request to change the value ofEnabled
tofalse
. -
Submit a
PUT Streaming Distribution Config
request 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-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Streaming Distribution Config
request in Step 2. -
Review the response to the
PUT Streaming Distribution Config
request to confirm that the distribution was successfully disabled. -
Submit a
GET Streaming Distribution Config
request to confirm that your changes have propagated. When propagation is complete, the value ofStatus
isDeployed
. -
Submit a
DELETE Streaming Distribution
request. Set the value of the HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Streaming Distribution Config
request in Step 2. -
Review the response to your
DELETE Streaming Distribution
request 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 Config
request to get the current configuration and theEtag
header for the distribution. -
Update the XML document that was returned in the response to your
GET Streaming Distribution Config
request to change the value ofEnabled
tofalse
. -
Submit a
PUT Streaming Distribution Config
request 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-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Streaming Distribution Config
request in Step 2. -
Review the response to the
PUT Streaming Distribution Config
request to confirm that the distribution was successfully disabled. -
Submit a
GET Streaming Distribution Config
request to confirm that your changes have propagated. When propagation is complete, the value ofStatus
isDeployed
. -
Submit a
DELETE Streaming Distribution
request. Set the value of the HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Streaming Distribution Config
request in Step 2. -
Review the response to your
DELETE Streaming Distribution
request 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.Builder
avoiding the need to create one manually viaDeleteStreamingDistributionRequest.builder()
- Parameters:
deleteStreamingDistributionRequest
- AConsumer
that will call methods onDeleteStreamingDistributionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaDescribeFunctionRequest.builder()
- Parameters:
describeFunctionRequest
- AConsumer
that will call methods onDescribeFunctionRequest.Builder
to create a request.- Returns:
- Result of the DescribeFunction 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
ListDistributions
orGetDistribution
. 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
ListDistributions
orGetDistribution
. 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.Builder
avoiding the need to create one manually viaGetCachePolicyRequest.builder()
- Parameters:
getCachePolicyRequest
- AConsumer
that will call methods onGetCachePolicyRequest.Builder
to 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
ListDistributions
orGetDistribution
. 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
ListDistributions
orGetDistribution
. 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.Builder
avoiding the need to create one manually viaGetCachePolicyConfigRequest.builder()
- Parameters:
getCachePolicyConfigRequest
- AConsumer
that will call methods onGetCachePolicyConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetCloudFrontOriginAccessIdentityRequest.builder()
- Parameters:
getCloudFrontOriginAccessIdentityRequest
- AConsumer
that will call methods onGetCloudFrontOriginAccessIdentityRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetCloudFrontOriginAccessIdentityConfigRequest.builder()
- Parameters:
getCloudFrontOriginAccessIdentityConfigRequest
- AConsumer
that will call methods onGetCloudFrontOriginAccessIdentityConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetContinuousDeploymentPolicyRequest.builder()
- Parameters:
getContinuousDeploymentPolicyRequest
- AConsumer
that will call methods onGetContinuousDeploymentPolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetContinuousDeploymentPolicyConfigRequest.builder()
- Parameters:
getContinuousDeploymentPolicyConfigRequest
- AConsumer
that will call methods onGetContinuousDeploymentPolicyConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetDistributionRequest.builder()
- Parameters:
getDistributionRequest
- AConsumer
that will call methods onGetDistributionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetDistributionConfigRequest.builder()
- Parameters:
getDistributionConfigRequest
- AConsumer
that will call methods onGetDistributionConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetFieldLevelEncryptionRequest.builder()
- Parameters:
getFieldLevelEncryptionRequest
- AConsumer
that will call methods onGetFieldLevelEncryptionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetFieldLevelEncryptionConfigRequest.builder()
- Parameters:
getFieldLevelEncryptionConfigRequest
- AConsumer
that will call methods onGetFieldLevelEncryptionConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetFieldLevelEncryptionProfileRequest.builder()
- Parameters:
getFieldLevelEncryptionProfileRequest
- AConsumer
that will call methods onGetFieldLevelEncryptionProfileRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetFieldLevelEncryptionProfileConfigRequest.builder()
- Parameters:
getFieldLevelEncryptionProfileConfigRequest
- AConsumer
that will call methods onGetFieldLevelEncryptionProfileConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetFunctionRequest.builder()
- Parameters:
getFunctionRequest
- AConsumer
that will call methods onGetFunctionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetInvalidationRequest.builder()
- Parameters:
getInvalidationRequest
- AConsumer
that will call methods onGetInvalidationRequest.Builder
to 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
ListDistributions
orGetDistribution
. 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
ListDistributions
orGetDistribution
. 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.Builder
avoiding the need to create one manually viaGetKeyGroupRequest.builder()
- Parameters:
getKeyGroupRequest
- AConsumer
that will call methods onGetKeyGroupRequest.Builder
to 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
ListDistributions
orGetDistribution
. 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
ListDistributions
orGetDistribution
. 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.Builder
avoiding the need to create one manually viaGetKeyGroupConfigRequest.builder()
- Parameters:
getKeyGroupConfigRequest
- AConsumer
that will call methods onGetKeyGroupConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetMonitoringSubscriptionRequest.builder()
- Parameters:
getMonitoringSubscriptionRequest
- AConsumer
that will call methods onGetMonitoringSubscriptionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetOriginAccessControlRequest.builder()
- Parameters:
getOriginAccessControlRequest
- AConsumer
that will call methods onGetOriginAccessControlRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetOriginAccessControlConfigRequest.builder()
- Parameters:
getOriginAccessControlConfigRequest
- AConsumer
that will call methods onGetOriginAccessControlConfigRequest.Builder
to 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
ListDistributions
orGetDistribution
. 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
ListDistributions
orGetDistribution
. 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.Builder
avoiding the need to create one manually viaGetOriginRequestPolicyRequest.builder()
- Parameters:
getOriginRequestPolicyRequest
- AConsumer
that will call methods onGetOriginRequestPolicyRequest.Builder
to 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
ListDistributions
orGetDistribution
. 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
ListDistributions
orGetDistribution
. 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.Builder
avoiding the need to create one manually viaGetOriginRequestPolicyConfigRequest.builder()
- Parameters:
getOriginRequestPolicyConfigRequest
- AConsumer
that will call methods onGetOriginRequestPolicyConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetPublicKeyRequest.builder()
- Parameters:
getPublicKeyRequest
- AConsumer
that will call methods onGetPublicKeyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetPublicKeyConfigRequest.builder()
- Parameters:
getPublicKeyConfigRequest
- AConsumer
that will call methods onGetPublicKeyConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetRealtimeLogConfigRequest.builder()
- Parameters:
getRealtimeLogConfigRequest
- AConsumer
that will call methods onGetRealtimeLogConfigRequest.Builder
to 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
ListDistributions
orGetDistribution
. 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
ListDistributions
orGetDistribution
. 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.Builder
avoiding the need to create one manually viaGetResponseHeadersPolicyRequest.builder()
- Parameters:
getResponseHeadersPolicyRequest
- AConsumer
that will call methods onGetResponseHeadersPolicyRequest.Builder
to 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
ListDistributions
orGetDistribution
. 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
ListDistributions
orGetDistribution
. 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.Builder
avoiding the need to create one manually viaGetResponseHeadersPolicyConfigRequest.builder()
- Parameters:
getResponseHeadersPolicyConfigRequest
- AConsumer
that will call methods onGetResponseHeadersPolicyConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetStreamingDistributionRequest.builder()
- Parameters:
getStreamingDistributionRequest
- AConsumer
that will call methods onGetStreamingDistributionRequest.Builder
to 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.Builder
avoiding the need to create one manually viaGetStreamingDistributionConfigRequest.builder()
- Parameters:
getStreamingDistributionConfigRequest
- AConsumer
that will call methods onGetStreamingDistributionConfigRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListCachePoliciesRequest.Builder
avoiding the need to create one manually viaListCachePoliciesRequest.builder()
- Parameters:
listCachePoliciesRequest
- AConsumer
that will call methods onListCachePoliciesRequest.Builder
to 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.Builder
avoiding the need to create one manually viaListCloudFrontOriginAccessIdentitiesRequest.builder()
- Parameters:
listCloudFrontOriginAccessIdentitiesRequest
- AConsumer
that will call methods onListCloudFrontOriginAccessIdentitiesRequest.Builder
to 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.com
as input, the returned list can includewww.example.com
and the overlapping wildcard alternate domain name (*.example.com
), if they exist. If you provide*.example.com
as input, the returned list can include*.example.com
and 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
NextMarker
value from the current response as theMarker
value 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.com
as input, the returned list can includewww.example.com
and the overlapping wildcard alternate domain name (*.example.com
), if they exist. If you provide*.example.com
as input, the returned list can include*.example.com
and 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListConflictingAliasesRequest.Builder
avoiding the need to create one manually viaListConflictingAliasesRequest.builder()
- Parameters:
listConflictingAliasesRequest
- AConsumer
that will call methods onListConflictingAliasesRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListContinuousDeploymentPoliciesRequest.Builder
avoiding the need to create one manually viaListContinuousDeploymentPoliciesRequest.builder()
- Parameters:
listContinuousDeploymentPoliciesRequest
- AConsumer
that will call methods onListContinuousDeploymentPoliciesRequest.Builder
to 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.Builder
avoiding the need to create one manually viaListDistributionsRequest.builder()
- Parameters:
listDistributionsRequest
- AConsumer
that will call methods onListDistributionsRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByCachePolicyIdRequest.Builder
avoiding the need to create one manually viaListDistributionsByCachePolicyIdRequest.builder()
- Parameters:
listDistributionsByCachePolicyIdRequest
- AConsumer
that will call methods onListDistributionsByCachePolicyIdRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByKeyGroupRequest.Builder
avoiding the need to create one manually viaListDistributionsByKeyGroupRequest.builder()
- Parameters:
listDistributionsByKeyGroupRequest
- AConsumer
that will call methods onListDistributionsByKeyGroupRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByOriginRequestPolicyIdRequest.Builder
avoiding the need to create one manually viaListDistributionsByOriginRequestPolicyIdRequest.builder()
- Parameters:
listDistributionsByOriginRequestPolicyIdRequest
- AConsumer
that will call methods onListDistributionsByOriginRequestPolicyIdRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByRealtimeLogConfigRequest.Builder
avoiding the need to create one manually viaListDistributionsByRealtimeLogConfigRequest.builder()
- Parameters:
listDistributionsByRealtimeLogConfigRequest
- AConsumer
that will call methods onListDistributionsByRealtimeLogConfigRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListDistributionsByResponseHeadersPolicyIdRequest.Builder
avoiding the need to create one manually viaListDistributionsByResponseHeadersPolicyIdRequest.builder()
- Parameters:
listDistributionsByResponseHeadersPolicyIdRequest
- AConsumer
that will call methods onListDistributionsByResponseHeadersPolicyIdRequest.Builder
to 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.Builder
avoiding the need to create one manually viaListDistributionsByWebAclIdRequest.builder()
- Parameters:
listDistributionsByWebAclIdRequest
- AConsumer
that will call methods onListDistributionsByWebAclIdRequest.Builder
to 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.Builder
avoiding the need to create one manually viaListFieldLevelEncryptionConfigsRequest.builder()
- Parameters:
listFieldLevelEncryptionConfigsRequest
- AConsumer
that will call methods onListFieldLevelEncryptionConfigsRequest.Builder
to 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.Builder
avoiding the need to create one manually viaListFieldLevelEncryptionProfilesRequest.builder()
- Parameters:
listFieldLevelEncryptionProfilesRequest
- AConsumer
that will call methods onListFieldLevelEncryptionProfilesRequest.Builder
to 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
DEVELOPMENT
orLIVE
.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
NextMarker
value from the current response as theMarker
value 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
DEVELOPMENT
orLIVE
.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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListFunctionsRequest.Builder
avoiding the need to create one manually viaListFunctionsRequest.builder()
- Parameters:
listFunctionsRequest
- AConsumer
that will call methods onListFunctionsRequest.Builder
to 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.Builder
avoiding the need to create one manually viaListInvalidationsRequest.builder()
- Parameters:
listInvalidationsRequest
- AConsumer
that will call methods onListInvalidationsRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListKeyGroupsRequest.Builder
avoiding the need to create one manually viaListKeyGroupsRequest.builder()
- Parameters:
listKeyGroupsRequest
- AConsumer
that will call methods onListKeyGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListKeyGroups 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the next request.
This is a convenience which creates an instance of the
ListOriginAccessControlsRequest.Builder
avoiding the need to create one manually viaListOriginAccessControlsRequest.builder()
- Parameters:
listOriginAccessControlsRequest
- AConsumer
that will call methods onListOriginAccessControlsRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListOriginRequestPoliciesRequest.Builder
avoiding the need to create one manually viaListOriginRequestPoliciesRequest.builder()
- Parameters:
listOriginRequestPoliciesRequest
- AConsumer
that will call methods onListOriginRequestPoliciesRequest.Builder
to 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.Builder
avoiding the need to create one manually viaListPublicKeysRequest.builder()
- Parameters:
listPublicKeysRequest
- AConsumer
that will call methods onListPublicKeysRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListRealtimeLogConfigsRequest.Builder
avoiding the need to create one manually viaListRealtimeLogConfigsRequest.builder()
- Parameters:
listRealtimeLogConfigsRequest
- AConsumer
that will call methods onListRealtimeLogConfigsRequest.Builder
to 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
NextMarker
value from the current response as theMarker
value 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
NextMarker
value from the current response as theMarker
value in the subsequent request.
This is a convenience which creates an instance of the
ListResponseHeadersPoliciesRequest.Builder
avoiding the need to create one manually viaListResponseHeadersPoliciesRequest.builder()
- Parameters:
listResponseHeadersPoliciesRequest
- AConsumer
that will call methods onListResponseHeadersPoliciesRequest.Builder
to 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.Builder
avoiding the need to create one manually viaListStreamingDistributionsRequest.builder()
- Parameters:
listStreamingDistributionsRequest
- AConsumer
that will call methods onListStreamingDistributionsRequest.Builder
to 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.
- 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.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to 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
DEVELOPMENT
stage toLIVE
. This automatically updates all cache behaviors that are using this function to use the newly published copy in theLIVE
stage.When a function is published to the
LIVE
stage, 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 (
ETag
value). To get these values, you can useListFunctions
andDescribeFunction
.- 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
DEVELOPMENT
stage toLIVE
. This automatically updates all cache behaviors that are using this function to use the newly published copy in theLIVE
stage.When a function is published to the
LIVE
stage, 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 (
ETag
value). To get these values, you can useListFunctions
andDescribeFunction
.
This is a convenience which creates an instance of the
PublishFunctionRequest.Builder
avoiding the need to create one manually viaPublishFunctionRequest.builder()
- Parameters:
publishFunctionRequest
- AConsumer
that will call methods onPublishFunctionRequest.Builder
to 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.
- 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to 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 (
ETag
value) along with the event object. To get the function's name and version, you can useListFunctions
andDescribeFunction
.- 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 (
ETag
value) along with the event object. To get the function's name and version, you can useListFunctions
andDescribeFunction
.
This is a convenience which creates an instance of the
TestFunctionRequest.Builder
avoiding the need to create one manually viaTestFunctionRequest.builder()
- Parameters:
testFunctionRequest
- AConsumer
that will call methods onTestFunctionRequest.Builder
to 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.
- 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.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to 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
GetCachePolicyConfig
to get the current configuration. -
Locally modify the fields in the cache policy configuration that you want to update.
-
Call
UpdateCachePolicy
by 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
GetCachePolicyConfig
to get the current configuration. -
Locally modify the fields in the cache policy configuration that you want to update.
-
Call
UpdateCachePolicy
by 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.Builder
avoiding the need to create one manually viaUpdateCachePolicyRequest.builder()
- Parameters:
updateCachePolicyRequest
- AConsumer
that will call methods onUpdateCachePolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaUpdateCloudFrontOriginAccessIdentityRequest.builder()
- Parameters:
updateCloudFrontOriginAccessIdentityRequest
- AConsumer
that will call methods onUpdateCloudFrontOriginAccessIdentityRequest.Builder
to 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
GetContinuousDeploymentPolicyConfig
to 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
GetContinuousDeploymentPolicyConfig
to 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.Builder
avoiding the need to create one manually viaUpdateContinuousDeploymentPolicyRequest.builder()
- Parameters:
updateContinuousDeploymentPolicyRequest
- AConsumer
that will call methods onUpdateContinuousDeploymentPolicyRequest.Builder
to 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
UpdateDistribution
request to make the updates.To update a web distribution using the CloudFront API
-
Use
GetDistributionConfig
to 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
ETag
field toIfMatch
, leaving the value unchanged. (Set the value ofIfMatch
to the value ofETag
, then remove theETag
field.) -
You can't change the value of
CallerReference
.
-
-
Submit an
UpdateDistribution
request, providing the distribution configuration. The new configuration replaces the existing configuration. The values that you specify in anUpdateDistribution
request 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
UpdateDistribution
request to make the updates.To update a web distribution using the CloudFront API
-
Use
GetDistributionConfig
to 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
ETag
field toIfMatch
, leaving the value unchanged. (Set the value ofIfMatch
to the value ofETag
, then remove theETag
field.) -
You can't change the value of
CallerReference
.
-
-
Submit an
UpdateDistribution
request, providing the distribution configuration. The new configuration replaces the existing configuration. The values that you specify in anUpdateDistribution
request 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.Builder
avoiding the need to create one manually viaUpdateDistributionRequest.builder()
- Parameters:
updateDistributionRequest
- AConsumer
that will call methods onUpdateDistributionRequest.Builder
to 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) andContinuousDeploymentPolicyId
value, 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) andContinuousDeploymentPolicyId
value, 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.Builder
avoiding the need to create one manually viaUpdateDistributionWithStagingConfigRequest.builder()
- Parameters:
updateDistributionWithStagingConfigRequest
- AConsumer
that will call methods onUpdateDistributionWithStagingConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaUpdateFieldLevelEncryptionConfigRequest.builder()
- Parameters:
updateFieldLevelEncryptionConfigRequest
- AConsumer
that will call methods onUpdateFieldLevelEncryptionConfigRequest.Builder
to 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.Builder
avoiding the need to create one manually viaUpdateFieldLevelEncryptionProfileRequest.builder()
- Parameters:
updateFieldLevelEncryptionProfileRequest
- AConsumer
that will call methods onUpdateFieldLevelEncryptionProfileRequest.Builder
to 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 (
ETag
value) along with the updated function code. To get the name and version, you can useListFunctions
andDescribeFunction
.- 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 (
ETag
value) along with the updated function code. To get the name and version, you can useListFunctions
andDescribeFunction
.
This is a convenience which creates an instance of the
UpdateFunctionRequest.Builder
avoiding the need to create one manually viaUpdateFunctionRequest.builder()
- Parameters:
updateFunctionRequest
- AConsumer
that will call methods onUpdateFunctionRequest.Builder
to 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
GetKeyGroup
orGetKeyGroupConfig
. -
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
-
Call
UpdateKeyGroup
with 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
GetKeyGroup
orGetKeyGroupConfig
. -
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
-
Call
UpdateKeyGroup
with 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.Builder
avoiding the need to create one manually viaUpdateKeyGroupRequest.builder()
- Parameters:
updateKeyGroupRequest
- AConsumer
that will call methods onUpdateKeyGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateKeyGroup 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.Builder
avoiding the need to create one manually viaUpdateOriginAccessControlRequest.builder()
- Parameters:
updateOriginAccessControlRequest
- AConsumer
that will call methods onUpdateOriginAccessControlRequest.Builder
to 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
GetOriginRequestPolicyConfig
to get the current configuration. -
Locally modify the fields in the origin request policy configuration that you want to update.
-
Call
UpdateOriginRequestPolicy
by 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
GetOriginRequestPolicyConfig
to get the current configuration. -
Locally modify the fields in the origin request policy configuration that you want to update.
-
Call
UpdateOriginRequestPolicy
by 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.Builder
avoiding the need to create one manually viaUpdateOriginRequestPolicyRequest.builder()
- Parameters:
updateOriginRequestPolicyRequest
- AConsumer
that will call methods onUpdateOriginRequestPolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaUpdatePublicKeyRequest.builder()
- Parameters:
updatePublicKeyRequest
- AConsumer
that will call methods onUpdatePublicKeyRequest.Builder
to 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
GetRealtimeLogConfig
to 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
Name
orARN
.- 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
GetRealtimeLogConfig
to 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
Name
orARN
.
This is a convenience which creates an instance of the
UpdateRealtimeLogConfigRequest.Builder
avoiding the need to create one manually viaUpdateRealtimeLogConfigRequest.builder()
- Parameters:
updateRealtimeLogConfigRequest
- AConsumer
that will call methods onUpdateRealtimeLogConfigRequest.Builder
to 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
GetResponseHeadersPolicyConfig
to 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
GetResponseHeadersPolicyConfig
to 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.Builder
avoiding the need to create one manually viaUpdateResponseHeadersPolicyRequest.builder()
- Parameters:
updateResponseHeadersPolicyRequest
- AConsumer
that will call methods onUpdateResponseHeadersPolicyRequest.Builder
to 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.Builder
avoiding the need to create one manually viaUpdateStreamingDistributionRequest.builder()
- Parameters:
updateStreamingDistributionRequest
- AConsumer
that will call methods onUpdateStreamingDistributionRequest.Builder
to 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 ofCloudFrontUtilities
object with the configuration set on this client. -
waiter
Create an instance ofCloudFrontWaiter
using 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 aCloudFrontClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCloudFrontClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-