libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudFront.Lens

Contents

Description

 
Synopsis

Operations

DeleteOriginRequestPolicy

deleteOriginRequestPolicy_ifMatch :: Lens' DeleteOriginRequestPolicy (Maybe Text) Source #

The version of the origin request policy that you are deleting. The version is the origin request policy’s ETag value, which you can get using ListOriginRequestPolicies, GetOriginRequestPolicy, or GetOriginRequestPolicyConfig.

deleteOriginRequestPolicy_id :: Lens' DeleteOriginRequestPolicy Text Source #

The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use ListOriginRequestPolicies.

UpdateOriginRequestPolicy

updateOriginRequestPolicy_ifMatch :: Lens' UpdateOriginRequestPolicy (Maybe Text) Source #

The version of the origin request policy that you are updating. The version is returned in the origin request policy’s ETag field in the response to GetOriginRequestPolicyConfig.

updateOriginRequestPolicy_originRequestPolicyConfig :: Lens' UpdateOriginRequestPolicy OriginRequestPolicyConfig Source #

An origin request policy configuration.

updateOriginRequestPolicy_id :: Lens' UpdateOriginRequestPolicy Text Source #

The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache behavior’s OriginRequestPolicyId field in the response to GetDistributionConfig.

updateOriginRequestPolicyResponse_eTag :: Lens' UpdateOriginRequestPolicyResponse (Maybe Text) Source #

The current version of the origin request policy.

updateOriginRequestPolicyResponse_originRequestPolicy :: Lens' UpdateOriginRequestPolicyResponse (Maybe OriginRequestPolicy) Source #

An origin request policy.

updateOriginRequestPolicyResponse_httpStatus :: Lens' UpdateOriginRequestPolicyResponse Int Source #

The response's http status code.

ListConflictingAliases

listConflictingAliases_marker :: Lens' ListConflictingAliases (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listConflictingAliases_maxItems :: Lens' ListConflictingAliases (Maybe Int) Source #

The maximum number of conflicting aliases that you want in the response.

listConflictingAliases_distributionId :: Lens' ListConflictingAliases Text Source #

The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.

listConflictingAliases_alias :: Lens' ListConflictingAliases Text Source #

The alias (also called a CNAME) to search for conflicting aliases.

listConflictingAliasesResponse_conflictingAliasesList :: Lens' ListConflictingAliasesResponse (Maybe ConflictingAliasesList) Source #

A list of conflicting aliases.

listConflictingAliasesResponse_httpStatus :: Lens' ListConflictingAliasesResponse Int Source #

The response's http status code.

DeleteStreamingDistribution

deleteStreamingDistribution_ifMatch :: Lens' DeleteStreamingDistribution (Maybe Text) Source #

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

deleteStreamingDistribution_id :: Lens' DeleteStreamingDistribution Text Source #

The distribution ID.

UpdateStreamingDistribution

updateStreamingDistribution_ifMatch :: Lens' UpdateStreamingDistribution (Maybe Text) Source #

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

updateStreamingDistribution_streamingDistributionConfig :: Lens' UpdateStreamingDistribution StreamingDistributionConfig Source #

The streaming distribution's configuration information.

updateStreamingDistribution_id :: Lens' UpdateStreamingDistribution Text Source #

The streaming distribution's id.

updateStreamingDistributionResponse_eTag :: Lens' UpdateStreamingDistributionResponse (Maybe Text) Source #

The current version of the configuration. For example: E2QWRUHAPOMQZL.

updateStreamingDistributionResponse_streamingDistribution :: Lens' UpdateStreamingDistributionResponse (Maybe StreamingDistribution) Source #

The streaming distribution's information.

updateStreamingDistributionResponse_httpStatus :: Lens' UpdateStreamingDistributionResponse Int Source #

The response's http status code.

ListPublicKeys

listPublicKeys_marker :: Lens' ListPublicKeys (Maybe Text) Source #

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page).

listPublicKeys_maxItems :: Lens' ListPublicKeys (Maybe Text) Source #

The maximum number of public keys you want in the response body.

listPublicKeysResponse_publicKeyList :: Lens' ListPublicKeysResponse (Maybe PublicKeyList) Source #

Returns a list of all public keys that have been added to CloudFront for this account.

listPublicKeysResponse_httpStatus :: Lens' ListPublicKeysResponse Int Source #

The response's http status code.

GetFieldLevelEncryptionConfig

getFieldLevelEncryptionConfig_id :: Lens' GetFieldLevelEncryptionConfig Text Source #

Request the ID for the field-level encryption configuration information.

getFieldLevelEncryptionConfigResponse_eTag :: Lens' GetFieldLevelEncryptionConfigResponse (Maybe Text) Source #

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

getFieldLevelEncryptionConfigResponse_fieldLevelEncryptionConfig :: Lens' GetFieldLevelEncryptionConfigResponse (Maybe FieldLevelEncryptionConfig) Source #

Return the field-level encryption configuration information.

getFieldLevelEncryptionConfigResponse_httpStatus :: Lens' GetFieldLevelEncryptionConfigResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resource :: Lens' ListTagsForResource Text Source #

An ARN of a CloudFront resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse Tags Source #

A complex type that contains zero or more Tag elements.

CreatePublicKey

createPublicKey_publicKeyConfig :: Lens' CreatePublicKey PublicKeyConfig Source #

A CloudFront public key configuration.

createPublicKeyResponse_eTag :: Lens' CreatePublicKeyResponse (Maybe Text) Source #

The identifier for this version of the public key.

createPublicKeyResponse_location :: Lens' CreatePublicKeyResponse (Maybe Text) Source #

The URL of the public key.

createPublicKeyResponse_publicKey :: Lens' CreatePublicKeyResponse (Maybe PublicKey) Source #

The public key.

createPublicKeyResponse_httpStatus :: Lens' CreatePublicKeyResponse Int Source #

The response's http status code.

GetPublicKeyConfig

getPublicKeyConfig_id :: Lens' GetPublicKeyConfig Text Source #

The identifier of the public key whose configuration you are getting.

getPublicKeyConfigResponse_eTag :: Lens' GetPublicKeyConfigResponse (Maybe Text) Source #

The identifier for this version of the public key configuration.

getPublicKeyConfigResponse_publicKeyConfig :: Lens' GetPublicKeyConfigResponse (Maybe PublicKeyConfig) Source #

A public key configuration.

getPublicKeyConfigResponse_httpStatus :: Lens' GetPublicKeyConfigResponse Int Source #

The response's http status code.

CreateDistributionWithTags

createDistributionWithTags_distributionConfigWithTags :: Lens' CreateDistributionWithTags DistributionConfigWithTags Source #

The distribution's configuration information.

createDistributionWithTagsResponse_eTag :: Lens' CreateDistributionWithTagsResponse (Maybe Text) Source #

The current version of the distribution created.

createDistributionWithTagsResponse_distribution :: Lens' CreateDistributionWithTagsResponse (Maybe Distribution) Source #

The distribution's information.

createDistributionWithTagsResponse_location :: Lens' CreateDistributionWithTagsResponse (Maybe Text) Source #

The fully qualified URI of the new distribution resource just created.

createDistributionWithTagsResponse_httpStatus :: Lens' CreateDistributionWithTagsResponse Int Source #

The response's http status code.

CreateFieldLevelEncryptionConfig

createFieldLevelEncryptionConfig_fieldLevelEncryptionConfig :: Lens' CreateFieldLevelEncryptionConfig FieldLevelEncryptionConfig Source #

The request to create a new field-level encryption configuration.

createFieldLevelEncryptionConfigResponse_eTag :: Lens' CreateFieldLevelEncryptionConfigResponse (Maybe Text) Source #

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

createFieldLevelEncryptionConfigResponse_location :: Lens' CreateFieldLevelEncryptionConfigResponse (Maybe Text) Source #

The fully qualified URI of the new configuration resource just created.

createFieldLevelEncryptionConfigResponse_fieldLevelEncryption :: Lens' CreateFieldLevelEncryptionConfigResponse (Maybe FieldLevelEncryption) Source #

Returned when you create a new field-level encryption configuration.

createFieldLevelEncryptionConfigResponse_httpStatus :: Lens' CreateFieldLevelEncryptionConfigResponse Int Source #

The response's http status code.

DeleteCachePolicy

deleteCachePolicy_ifMatch :: Lens' DeleteCachePolicy (Maybe Text) Source #

The version of the cache policy that you are deleting. The version is the cache policy’s ETag value, which you can get using ListCachePolicies, GetCachePolicy, or GetCachePolicyConfig.

deleteCachePolicy_id :: Lens' DeleteCachePolicy Text Source #

The unique identifier for the cache policy that you are deleting. To get the identifier, you can use ListCachePolicies.

UpdateCachePolicy

updateCachePolicy_ifMatch :: Lens' UpdateCachePolicy (Maybe Text) Source #

The version of the cache policy that you are updating. The version is returned in the cache policy’s ETag field in the response to GetCachePolicyConfig.

updateCachePolicy_cachePolicyConfig :: Lens' UpdateCachePolicy CachePolicyConfig Source #

A cache policy configuration.

updateCachePolicy_id :: Lens' UpdateCachePolicy Text Source #

The unique identifier for the cache policy that you are updating. The identifier is returned in a cache behavior’s CachePolicyId field in the response to GetDistributionConfig.

updateCachePolicyResponse_cachePolicy :: Lens' UpdateCachePolicyResponse (Maybe CachePolicy) Source #

A cache policy.

updateCachePolicyResponse_eTag :: Lens' UpdateCachePolicyResponse (Maybe Text) Source #

The current version of the cache policy.

updateCachePolicyResponse_httpStatus :: Lens' UpdateCachePolicyResponse Int Source #

The response's http status code.

GetFieldLevelEncryption

getFieldLevelEncryption_id :: Lens' GetFieldLevelEncryption Text Source #

Request the ID for the field-level encryption configuration information.

getFieldLevelEncryptionResponse_eTag :: Lens' GetFieldLevelEncryptionResponse (Maybe Text) Source #

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

getFieldLevelEncryptionResponse_fieldLevelEncryption :: Lens' GetFieldLevelEncryptionResponse (Maybe FieldLevelEncryption) Source #

Return the field-level encryption configuration information.

getFieldLevelEncryptionResponse_httpStatus :: Lens' GetFieldLevelEncryptionResponse Int Source #

The response's http status code.

ListRealtimeLogConfigs

listRealtimeLogConfigs_marker :: Lens' ListRealtimeLogConfigs (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listRealtimeLogConfigs_maxItems :: Lens' ListRealtimeLogConfigs (Maybe Text) Source #

The maximum number of real-time log configurations that you want in the response.

listRealtimeLogConfigsResponse_realtimeLogConfigs :: Lens' ListRealtimeLogConfigsResponse (Maybe RealtimeLogConfigs) Source #

A list of real-time log configurations.

listRealtimeLogConfigsResponse_httpStatus :: Lens' ListRealtimeLogConfigsResponse Int Source #

The response's http status code.

GetPublicKey

getPublicKey_id :: Lens' GetPublicKey Text Source #

The identifier of the public key you are getting.

getPublicKeyResponse_eTag :: Lens' GetPublicKeyResponse (Maybe Text) Source #

The identifier for this version of the public key.

getPublicKeyResponse_publicKey :: Lens' GetPublicKeyResponse (Maybe PublicKey) Source #

The public key.

getPublicKeyResponse_httpStatus :: Lens' GetPublicKeyResponse Int Source #

The response's http status code.

DeleteRealtimeLogConfig

deleteRealtimeLogConfig_arn :: Lens' DeleteRealtimeLogConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the real-time log configuration to delete.

deleteRealtimeLogConfig_name :: Lens' DeleteRealtimeLogConfig (Maybe Text) Source #

The name of the real-time log configuration to delete.

UpdateRealtimeLogConfig

updateRealtimeLogConfig_arn :: Lens' UpdateRealtimeLogConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) for this real-time log configuration.

updateRealtimeLogConfig_samplingRate :: Lens' UpdateRealtimeLogConfig (Maybe Integer) Source #

The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.

updateRealtimeLogConfig_name :: Lens' UpdateRealtimeLogConfig (Maybe Text) Source #

The name for this real-time log configuration.

updateRealtimeLogConfig_endPoints :: Lens' UpdateRealtimeLogConfig (Maybe [EndPoint]) Source #

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

updateRealtimeLogConfig_fields :: Lens' UpdateRealtimeLogConfig (Maybe [Text]) Source #

A list of fields to include in each real-time log record.

For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.

updateRealtimeLogConfigResponse_realtimeLogConfig :: Lens' UpdateRealtimeLogConfigResponse (Maybe RealtimeLogConfig) Source #

A real-time log configuration.

updateRealtimeLogConfigResponse_httpStatus :: Lens' UpdateRealtimeLogConfigResponse Int Source #

The response's http status code.

ListDistributionsByOriginRequestPolicyId

listDistributionsByOriginRequestPolicyId_marker :: Lens' ListDistributionsByOriginRequestPolicyId (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listDistributionsByOriginRequestPolicyId_maxItems :: Lens' ListDistributionsByOriginRequestPolicyId (Maybe Text) Source #

The maximum number of distribution IDs that you want in the response.

listDistributionsByOriginRequestPolicyId_originRequestPolicyId :: Lens' ListDistributionsByOriginRequestPolicyId Text Source #

The ID of the origin request policy whose associated distribution IDs you want to list.

listDistributionsByOriginRequestPolicyIdResponse_distributionIdList :: Lens' ListDistributionsByOriginRequestPolicyIdResponse (Maybe DistributionIdList) Source #

A list of distribution IDs.

listDistributionsByOriginRequestPolicyIdResponse_httpStatus :: Lens' ListDistributionsByOriginRequestPolicyIdResponse Int Source #

The response's http status code.

DeleteFieldLevelEncryptionConfig

deleteFieldLevelEncryptionConfig_ifMatch :: Lens' DeleteFieldLevelEncryptionConfig (Maybe Text) Source #

The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.

deleteFieldLevelEncryptionConfig_id :: Lens' DeleteFieldLevelEncryptionConfig Text Source #

The ID of the configuration you want to delete from CloudFront.

UpdateFieldLevelEncryptionConfig

updateFieldLevelEncryptionConfig_ifMatch :: Lens' UpdateFieldLevelEncryptionConfig (Maybe Text) Source #

The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.

updateFieldLevelEncryptionConfig_fieldLevelEncryptionConfig :: Lens' UpdateFieldLevelEncryptionConfig FieldLevelEncryptionConfig Source #

Request to update a field-level encryption configuration.

updateFieldLevelEncryptionConfig_id :: Lens' UpdateFieldLevelEncryptionConfig Text Source #

The ID of the configuration you want to update.

updateFieldLevelEncryptionConfigResponse_eTag :: Lens' UpdateFieldLevelEncryptionConfigResponse (Maybe Text) Source #

The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL.

updateFieldLevelEncryptionConfigResponse_fieldLevelEncryption :: Lens' UpdateFieldLevelEncryptionConfigResponse (Maybe FieldLevelEncryption) Source #

Return the results of updating the configuration.

updateFieldLevelEncryptionConfigResponse_httpStatus :: Lens' UpdateFieldLevelEncryptionConfigResponse Int Source #

The response's http status code.

GetKeyGroup

getKeyGroup_id :: Lens' GetKeyGroup Text Source #

The identifier of the key group that you are getting. To get the identifier, use ListKeyGroups.

getKeyGroupResponse_eTag :: Lens' GetKeyGroupResponse (Maybe Text) Source #

The identifier for this version of the key group.

getKeyGroupResponse_keyGroup :: Lens' GetKeyGroupResponse (Maybe KeyGroup) Source #

The key group.

getKeyGroupResponse_httpStatus :: Lens' GetKeyGroupResponse Int Source #

The response's http status code.

CreateDistribution

createDistribution_distributionConfig :: Lens' CreateDistribution DistributionConfig Source #

The distribution's configuration information.

createDistributionResponse_eTag :: Lens' CreateDistributionResponse (Maybe Text) Source #

The current version of the distribution created.

createDistributionResponse_distribution :: Lens' CreateDistributionResponse (Maybe Distribution) Source #

The distribution's information.

createDistributionResponse_location :: Lens' CreateDistributionResponse (Maybe Text) Source #

The fully qualified URI of the new distribution resource just created.

createDistributionResponse_httpStatus :: Lens' CreateDistributionResponse Int Source #

The response's http status code.

GetFieldLevelEncryptionProfile

getFieldLevelEncryptionProfile_id :: Lens' GetFieldLevelEncryptionProfile Text Source #

Get the ID for the field-level encryption profile information.

getFieldLevelEncryptionProfileResponse_eTag :: Lens' GetFieldLevelEncryptionProfileResponse (Maybe Text) Source #

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

getFieldLevelEncryptionProfileResponse_fieldLevelEncryptionProfile :: Lens' GetFieldLevelEncryptionProfileResponse (Maybe FieldLevelEncryptionProfile) Source #

Return the field-level encryption profile information.

getFieldLevelEncryptionProfileResponse_httpStatus :: Lens' GetFieldLevelEncryptionProfileResponse Int Source #

The response's http status code.

DeleteMonitoringSubscription

deleteMonitoringSubscription_distributionId :: Lens' DeleteMonitoringSubscription Text Source #

The ID of the distribution that you are disabling metrics for.

deleteMonitoringSubscriptionResponse_httpStatus :: Lens' DeleteMonitoringSubscriptionResponse Int Source #

The response's http status code.

CreateFunction

createFunction_name :: Lens' CreateFunction Text Source #

A name to identify the function.

createFunction_functionConfig :: Lens' CreateFunction FunctionConfig Source #

Configuration information about the function, including an optional comment and the function’s runtime.

createFunction_functionCode :: Lens' CreateFunction ByteString Source #

The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

createFunctionResponse_eTag :: Lens' CreateFunctionResponse (Maybe Text) Source #

The version identifier for the current version of the CloudFront function.

createFunctionResponse_location :: Lens' CreateFunctionResponse (Maybe Text) Source #

The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.

createFunctionResponse_functionSummary :: Lens' CreateFunctionResponse (Maybe FunctionSummary) Source #

Contains configuration information and metadata about a CloudFront function.

createFunctionResponse_httpStatus :: Lens' CreateFunctionResponse Int Source #

The response's http status code.

GetDistributionConfig

getDistributionConfig_id :: Lens' GetDistributionConfig Text Source #

The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

getDistributionConfigResponse_eTag :: Lens' GetDistributionConfigResponse (Maybe Text) Source #

The current version of the configuration. For example: E2QWRUHAPOMQZL.

getDistributionConfigResponse_distributionConfig :: Lens' GetDistributionConfigResponse (Maybe DistributionConfig) Source #

The distribution's configuration information.

getDistributionConfigResponse_httpStatus :: Lens' GetDistributionConfigResponse Int Source #

The response's http status code.

CreateStreamingDistributionWithTags

createStreamingDistributionWithTags_streamingDistributionConfigWithTags :: Lens' CreateStreamingDistributionWithTags StreamingDistributionConfigWithTags Source #

The streaming distribution's configuration information.

createStreamingDistributionWithTagsResponse_eTag :: Lens' CreateStreamingDistributionWithTagsResponse (Maybe Text) Source #

The current version of the distribution created.

createStreamingDistributionWithTagsResponse_location :: Lens' CreateStreamingDistributionWithTagsResponse (Maybe Text) Source #

The fully qualified URI of the new streaming distribution resource just created.

createStreamingDistributionWithTagsResponse_streamingDistribution :: Lens' CreateStreamingDistributionWithTagsResponse (Maybe StreamingDistribution) Source #

The streaming distribution's information.

createStreamingDistributionWithTagsResponse_httpStatus :: Lens' CreateStreamingDistributionWithTagsResponse Int Source #

The response's http status code.

DeleteFieldLevelEncryptionProfile

deleteFieldLevelEncryptionProfile_ifMatch :: Lens' DeleteFieldLevelEncryptionProfile (Maybe Text) Source #

The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL.

deleteFieldLevelEncryptionProfile_id :: Lens' DeleteFieldLevelEncryptionProfile Text Source #

Request the ID of the profile you want to delete from CloudFront.

UpdateFieldLevelEncryptionProfile

updateFieldLevelEncryptionProfile_ifMatch :: Lens' UpdateFieldLevelEncryptionProfile (Maybe Text) Source #

The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL.

updateFieldLevelEncryptionProfile_fieldLevelEncryptionProfileConfig :: Lens' UpdateFieldLevelEncryptionProfile FieldLevelEncryptionProfileConfig Source #

Request to update a field-level encryption profile.

updateFieldLevelEncryptionProfile_id :: Lens' UpdateFieldLevelEncryptionProfile Text Source #

The ID of the field-level encryption profile request.

updateFieldLevelEncryptionProfileResponse_eTag :: Lens' UpdateFieldLevelEncryptionProfileResponse (Maybe Text) Source #

The result of the field-level encryption profile request.

updateFieldLevelEncryptionProfileResponse_fieldLevelEncryptionProfile :: Lens' UpdateFieldLevelEncryptionProfileResponse (Maybe FieldLevelEncryptionProfile) Source #

Return the results of updating the profile.

updateFieldLevelEncryptionProfileResponse_httpStatus :: Lens' UpdateFieldLevelEncryptionProfileResponse Int Source #

The response's http status code.

ListDistributionsByCachePolicyId

listDistributionsByCachePolicyId_marker :: Lens' ListDistributionsByCachePolicyId (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listDistributionsByCachePolicyId_maxItems :: Lens' ListDistributionsByCachePolicyId (Maybe Text) Source #

The maximum number of distribution IDs that you want in the response.

listDistributionsByCachePolicyId_cachePolicyId :: Lens' ListDistributionsByCachePolicyId Text Source #

The ID of the cache policy whose associated distribution IDs you want to list.

listDistributionsByCachePolicyIdResponse_distributionIdList :: Lens' ListDistributionsByCachePolicyIdResponse (Maybe DistributionIdList) Source #

A list of distribution IDs.

listDistributionsByCachePolicyIdResponse_httpStatus :: Lens' ListDistributionsByCachePolicyIdResponse Int Source #

The response's http status code.

TestFunction

testFunction_stage :: Lens' TestFunction (Maybe FunctionStage) Source #

The stage of the function that you are testing, either DEVELOPMENT or LIVE.

testFunction_name :: Lens' TestFunction Text Source #

The name of the function that you are testing.

testFunction_ifMatch :: Lens' TestFunction Text Source #

The current version (ETag value) of the function that you are testing, which you can get using DescribeFunction.

testFunction_eventObject :: Lens' TestFunction ByteString Source #

The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

testFunctionResponse_testResult :: Lens' TestFunctionResponse (Maybe TestResult) Source #

An object that represents the result of running the function with the provided event object.

testFunctionResponse_httpStatus :: Lens' TestFunctionResponse Int Source #

The response's http status code.

CreateFieldLevelEncryptionProfile

createFieldLevelEncryptionProfile_fieldLevelEncryptionProfileConfig :: Lens' CreateFieldLevelEncryptionProfile FieldLevelEncryptionProfileConfig Source #

The request to create a field-level encryption profile.

createFieldLevelEncryptionProfileResponse_eTag :: Lens' CreateFieldLevelEncryptionProfileResponse (Maybe Text) Source #

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

createFieldLevelEncryptionProfileResponse_location :: Lens' CreateFieldLevelEncryptionProfileResponse (Maybe Text) Source #

The fully qualified URI of the new profile resource just created.

createFieldLevelEncryptionProfileResponse_fieldLevelEncryptionProfile :: Lens' CreateFieldLevelEncryptionProfileResponse (Maybe FieldLevelEncryptionProfile) Source #

Returned when you create a new field-level encryption profile.

createFieldLevelEncryptionProfileResponse_httpStatus :: Lens' CreateFieldLevelEncryptionProfileResponse Int Source #

The response's http status code.

GetKeyGroupConfig

getKeyGroupConfig_id :: Lens' GetKeyGroupConfig Text Source #

The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups.

getKeyGroupConfigResponse_eTag :: Lens' GetKeyGroupConfigResponse (Maybe Text) Source #

The identifier for this version of the key group.

getKeyGroupConfigResponse_keyGroupConfig :: Lens' GetKeyGroupConfigResponse (Maybe KeyGroupConfig) Source #

The key group configuration.

getKeyGroupConfigResponse_httpStatus :: Lens' GetKeyGroupConfigResponse Int Source #

The response's http status code.

GetDistribution

getDistribution_id :: Lens' GetDistribution Text Source #

The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

getDistributionResponse_eTag :: Lens' GetDistributionResponse (Maybe Text) Source #

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

getDistributionResponse_distribution :: Lens' GetDistributionResponse (Maybe Distribution) Source #

The distribution's information.

getDistributionResponse_httpStatus :: Lens' GetDistributionResponse Int Source #

The response's http status code.

GetFieldLevelEncryptionProfileConfig

getFieldLevelEncryptionProfileConfig_id :: Lens' GetFieldLevelEncryptionProfileConfig Text Source #

Get the ID for the field-level encryption profile configuration information.

getFieldLevelEncryptionProfileConfigResponse_eTag :: Lens' GetFieldLevelEncryptionProfileConfigResponse (Maybe Text) Source #

The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL.

getFieldLevelEncryptionProfileConfigResponse_fieldLevelEncryptionProfileConfig :: Lens' GetFieldLevelEncryptionProfileConfigResponse (Maybe FieldLevelEncryptionProfileConfig) Source #

Return the field-level encryption profile configuration information.

getFieldLevelEncryptionProfileConfigResponse_httpStatus :: Lens' GetFieldLevelEncryptionProfileConfigResponse Int Source #

The response's http status code.

GetFunction

getFunction_stage :: Lens' GetFunction (Maybe FunctionStage) Source #

The function’s stage, either DEVELOPMENT or LIVE.

getFunction_name :: Lens' GetFunction Text Source #

The name of the function whose code you are getting.

getFunctionResponse_eTag :: Lens' GetFunctionResponse (Maybe Text) Source #

The version identifier for the current version of the CloudFront function.

getFunctionResponse_functionCode :: Lens' GetFunctionResponse (Maybe ByteString) Source #

The function code of a CloudFront function.

getFunctionResponse_contentType :: Lens' GetFunctionResponse (Maybe Text) Source #

The content type (media type) of the response.

getFunctionResponse_httpStatus :: Lens' GetFunctionResponse Int Source #

The response's http status code.

CreateKeyGroup

createKeyGroup_keyGroupConfig :: Lens' CreateKeyGroup KeyGroupConfig Source #

A key group configuration.

createKeyGroupResponse_eTag :: Lens' CreateKeyGroupResponse (Maybe Text) Source #

The identifier for this version of the key group.

createKeyGroupResponse_location :: Lens' CreateKeyGroupResponse (Maybe Text) Source #

The URL of the key group.

createKeyGroupResponse_keyGroup :: Lens' CreateKeyGroupResponse (Maybe KeyGroup) Source #

The key group that was just created.

createKeyGroupResponse_httpStatus :: Lens' CreateKeyGroupResponse Int Source #

The response's http status code.

UpdateCloudFrontOriginAccessIdentity

updateCloudFrontOriginAccessIdentity_ifMatch :: Lens' UpdateCloudFrontOriginAccessIdentity (Maybe Text) Source #

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

updateCloudFrontOriginAccessIdentity_cloudFrontOriginAccessIdentityConfig :: Lens' UpdateCloudFrontOriginAccessIdentity CloudFrontOriginAccessIdentityConfig Source #

The identity's configuration information.

updateCloudFrontOriginAccessIdentity_id :: Lens' UpdateCloudFrontOriginAccessIdentity Text Source #

The identity's id.

updateCloudFrontOriginAccessIdentityResponse_eTag :: Lens' UpdateCloudFrontOriginAccessIdentityResponse (Maybe Text) Source #

The current version of the configuration. For example: E2QWRUHAPOMQZL.

updateCloudFrontOriginAccessIdentityResponse_cloudFrontOriginAccessIdentity :: Lens' UpdateCloudFrontOriginAccessIdentityResponse (Maybe CloudFrontOriginAccessIdentity) Source #

The origin access identity's information.

updateCloudFrontOriginAccessIdentityResponse_httpStatus :: Lens' UpdateCloudFrontOriginAccessIdentityResponse Int Source #

The response's http status code.

DeleteCloudFrontOriginAccessIdentity

deleteCloudFrontOriginAccessIdentity_ifMatch :: Lens' DeleteCloudFrontOriginAccessIdentity (Maybe Text) Source #

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

deleteCloudFrontOriginAccessIdentity_id :: Lens' DeleteCloudFrontOriginAccessIdentity Text Source #

The origin access identity's ID.

ListStreamingDistributions

listStreamingDistributions_marker :: Lens' ListStreamingDistributions (Maybe Text) Source #

The value that you provided for the Marker request parameter.

listStreamingDistributions_maxItems :: Lens' ListStreamingDistributions (Maybe Text) Source #

The value that you provided for the MaxItems request parameter.

listStreamingDistributionsResponse_httpStatus :: Lens' ListStreamingDistributionsResponse Int Source #

The response's http status code.

listStreamingDistributionsResponse_streamingDistributionList :: Lens' ListStreamingDistributionsResponse StreamingDistributionList Source #

The StreamingDistributionList type.

DeletePublicKey

deletePublicKey_ifMatch :: Lens' DeletePublicKey (Maybe Text) Source #

The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.

deletePublicKey_id :: Lens' DeletePublicKey Text Source #

The ID of the public key you want to remove from CloudFront.

UpdatePublicKey

updatePublicKey_ifMatch :: Lens' UpdatePublicKey (Maybe Text) Source #

The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.

updatePublicKey_publicKeyConfig :: Lens' UpdatePublicKey PublicKeyConfig Source #

A public key configuration.

updatePublicKey_id :: Lens' UpdatePublicKey Text Source #

The identifier of the public key that you are updating.

updatePublicKeyResponse_eTag :: Lens' UpdatePublicKeyResponse (Maybe Text) Source #

The identifier of the current version of the public key.

updatePublicKeyResponse_publicKey :: Lens' UpdatePublicKeyResponse (Maybe PublicKey) Source #

The public key.

updatePublicKeyResponse_httpStatus :: Lens' UpdatePublicKeyResponse Int Source #

The response's http status code.

GetRealtimeLogConfig

getRealtimeLogConfig_arn :: Lens' GetRealtimeLogConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the real-time log configuration to get.

getRealtimeLogConfig_name :: Lens' GetRealtimeLogConfig (Maybe Text) Source #

The name of the real-time log configuration to get.

getRealtimeLogConfigResponse_realtimeLogConfig :: Lens' GetRealtimeLogConfigResponse (Maybe RealtimeLogConfig) Source #

A real-time log configuration.

getRealtimeLogConfigResponse_httpStatus :: Lens' GetRealtimeLogConfigResponse Int Source #

The response's http status code.

DescribeFunction

describeFunction_stage :: Lens' DescribeFunction (Maybe FunctionStage) Source #

The function’s stage, either DEVELOPMENT or LIVE.

describeFunction_name :: Lens' DescribeFunction Text Source #

The name of the function that you are getting information about.

describeFunctionResponse_eTag :: Lens' DescribeFunctionResponse (Maybe Text) Source #

The version identifier for the current version of the CloudFront function.

describeFunctionResponse_functionSummary :: Lens' DescribeFunctionResponse (Maybe FunctionSummary) Source #

Contains configuration information and metadata about a CloudFront function.

describeFunctionResponse_httpStatus :: Lens' DescribeFunctionResponse Int Source #

The response's http status code.

GetStreamingDistributionConfig

getStreamingDistributionConfig_id :: Lens' GetStreamingDistributionConfig Text Source #

The streaming distribution's ID.

getStreamingDistributionConfigResponse_streamingDistributionConfig :: Lens' GetStreamingDistributionConfigResponse (Maybe StreamingDistributionConfig) Source #

The streaming distribution's configuration information.

getStreamingDistributionConfigResponse_eTag :: Lens' GetStreamingDistributionConfigResponse (Maybe Text) Source #

The current version of the configuration. For example: E2QWRUHAPOMQZL.

getStreamingDistributionConfigResponse_httpStatus :: Lens' GetStreamingDistributionConfigResponse Int Source #

The response's http status code.

GetCloudFrontOriginAccessIdentityConfig

getCloudFrontOriginAccessIdentityConfig_id :: Lens' GetCloudFrontOriginAccessIdentityConfig Text Source #

The identity's ID.

getCloudFrontOriginAccessIdentityConfigResponse_cloudFrontOriginAccessIdentityConfig :: Lens' GetCloudFrontOriginAccessIdentityConfigResponse (Maybe CloudFrontOriginAccessIdentityConfig) Source #

The origin access identity's configuration information.

getCloudFrontOriginAccessIdentityConfigResponse_eTag :: Lens' GetCloudFrontOriginAccessIdentityConfigResponse (Maybe Text) Source #

The current version of the configuration. For example: E2QWRUHAPOMQZL.

getCloudFrontOriginAccessIdentityConfigResponse_httpStatus :: Lens' GetCloudFrontOriginAccessIdentityConfigResponse Int Source #

The response's http status code.

CreateStreamingDistribution

createStreamingDistribution_streamingDistributionConfig :: Lens' CreateStreamingDistribution StreamingDistributionConfig Source #

The streaming distribution's configuration information.

createStreamingDistributionResponse_eTag :: Lens' CreateStreamingDistributionResponse (Maybe Text) Source #

The current version of the streaming distribution created.

createStreamingDistributionResponse_location :: Lens' CreateStreamingDistributionResponse (Maybe Text) Source #

The fully qualified URI of the new streaming distribution resource just created.

createStreamingDistributionResponse_streamingDistribution :: Lens' CreateStreamingDistributionResponse (Maybe StreamingDistribution) Source #

The streaming distribution's information.

createStreamingDistributionResponse_httpStatus :: Lens' CreateStreamingDistributionResponse Int Source #

The response's http status code.

CreateCloudFrontOriginAccessIdentity

createCloudFrontOriginAccessIdentity_cloudFrontOriginAccessIdentityConfig :: Lens' CreateCloudFrontOriginAccessIdentity CloudFrontOriginAccessIdentityConfig Source #

The current configuration information for the identity.

createCloudFrontOriginAccessIdentityResponse_eTag :: Lens' CreateCloudFrontOriginAccessIdentityResponse (Maybe Text) Source #

The current version of the origin access identity created.

createCloudFrontOriginAccessIdentityResponse_location :: Lens' CreateCloudFrontOriginAccessIdentityResponse (Maybe Text) Source #

The fully qualified URI of the new origin access identity just created.

createCloudFrontOriginAccessIdentityResponse_cloudFrontOriginAccessIdentity :: Lens' CreateCloudFrontOriginAccessIdentityResponse (Maybe CloudFrontOriginAccessIdentity) Source #

The origin access identity's information.

createCloudFrontOriginAccessIdentityResponse_httpStatus :: Lens' CreateCloudFrontOriginAccessIdentityResponse Int Source #

The response's http status code.

ListCloudFrontOriginAccessIdentities

listCloudFrontOriginAccessIdentities_marker :: Lens' ListCloudFrontOriginAccessIdentities (Maybe Text) Source #

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

listCloudFrontOriginAccessIdentities_maxItems :: Lens' ListCloudFrontOriginAccessIdentities (Maybe Text) Source #

The maximum number of origin access identities you want in the response body.

listCloudFrontOriginAccessIdentitiesResponse_httpStatus :: Lens' ListCloudFrontOriginAccessIdentitiesResponse Int Source #

The response's http status code.

listCloudFrontOriginAccessIdentitiesResponse_cloudFrontOriginAccessIdentityList :: Lens' ListCloudFrontOriginAccessIdentitiesResponse CloudFrontOriginAccessIdentityList Source #

The CloudFrontOriginAccessIdentityList type.

GetInvalidation

getInvalidation_distributionId :: Lens' GetInvalidation Text Source #

The distribution's ID.

getInvalidation_id :: Lens' GetInvalidation Text Source #

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

getInvalidationResponse_invalidation :: Lens' GetInvalidationResponse (Maybe Invalidation) Source #

The invalidation's information. For more information, see Invalidation Complex Type.

getInvalidationResponse_httpStatus :: Lens' GetInvalidationResponse Int Source #

The response's http status code.

GetCachePolicy

getCachePolicy_id :: Lens' GetCachePolicy Text Source #

The unique identifier for the cache policy. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.

getCachePolicyResponse_cachePolicy :: Lens' GetCachePolicyResponse (Maybe CachePolicy) Source #

The cache policy.

getCachePolicyResponse_eTag :: Lens' GetCachePolicyResponse (Maybe Text) Source #

The current version of the cache policy.

getCachePolicyResponse_httpStatus :: Lens' GetCachePolicyResponse Int Source #

The response's http status code.

AssociateAlias

associateAlias_targetDistributionId :: Lens' AssociateAlias Text Source #

The ID of the distribution that you’re associating the alias with.

associateAlias_alias :: Lens' AssociateAlias Text Source #

The alias (also known as a CNAME) to add to the target distribution.

CreateRealtimeLogConfig

createRealtimeLogConfig_endPoints :: Lens' CreateRealtimeLogConfig [EndPoint] Source #

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

createRealtimeLogConfig_fields :: Lens' CreateRealtimeLogConfig [Text] Source #

A list of fields to include in each real-time log record.

For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.

createRealtimeLogConfig_name :: Lens' CreateRealtimeLogConfig Text Source #

A unique name to identify this real-time log configuration.

createRealtimeLogConfig_samplingRate :: Lens' CreateRealtimeLogConfig Integer Source #

The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.

createRealtimeLogConfigResponse_realtimeLogConfig :: Lens' CreateRealtimeLogConfigResponse (Maybe RealtimeLogConfig) Source #

A real-time log configuration.

createRealtimeLogConfigResponse_httpStatus :: Lens' CreateRealtimeLogConfigResponse Int Source #

The response's http status code.

ListInvalidations

listInvalidations_marker :: Lens' ListInvalidations (Maybe Text) Source #

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

listInvalidations_maxItems :: Lens' ListInvalidations (Maybe Text) Source #

The maximum number of invalidation batches that you want in the response body.

listInvalidations_distributionId :: Lens' ListInvalidations Text Source #

The distribution's ID.

listInvalidationsResponse_httpStatus :: Lens' ListInvalidationsResponse Int Source #

The response's http status code.

listInvalidationsResponse_invalidationList :: Lens' ListInvalidationsResponse InvalidationList Source #

Information about invalidation batches.

CreateInvalidation

createInvalidation_distributionId :: Lens' CreateInvalidation Text Source #

The distribution's id.

createInvalidation_invalidationBatch :: Lens' CreateInvalidation InvalidationBatch Source #

The batch information for the invalidation.

createInvalidationResponse_invalidation :: Lens' CreateInvalidationResponse (Maybe Invalidation) Source #

The invalidation's information.

createInvalidationResponse_location :: Lens' CreateInvalidationResponse (Maybe Text) Source #

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

createInvalidationResponse_httpStatus :: Lens' CreateInvalidationResponse Int Source #

The response's http status code.

GetCloudFrontOriginAccessIdentity

getCloudFrontOriginAccessIdentity_id :: Lens' GetCloudFrontOriginAccessIdentity Text Source #

The identity's ID.

getCloudFrontOriginAccessIdentityResponse_eTag :: Lens' GetCloudFrontOriginAccessIdentityResponse (Maybe Text) Source #

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

getCloudFrontOriginAccessIdentityResponse_cloudFrontOriginAccessIdentity :: Lens' GetCloudFrontOriginAccessIdentityResponse (Maybe CloudFrontOriginAccessIdentity) Source #

The origin access identity's information.

getCloudFrontOriginAccessIdentityResponse_httpStatus :: Lens' GetCloudFrontOriginAccessIdentityResponse Int Source #

The response's http status code.

ListCachePolicies

listCachePolicies_marker :: Lens' ListCachePolicies (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listCachePolicies_maxItems :: Lens' ListCachePolicies (Maybe Text) Source #

The maximum number of cache policies that you want in the response.

listCachePolicies_type :: Lens' ListCachePolicies (Maybe CachePolicyType) Source #

A filter to return only the specified kinds of cache policies. Valid values are:

  • managed – Returns only the managed policies created by Amazon Web Services.
  • custom – Returns only the custom policies created in your account.

listCachePoliciesResponse_cachePolicyList :: Lens' ListCachePoliciesResponse (Maybe CachePolicyList) Source #

A list of cache policies.

listCachePoliciesResponse_httpStatus :: Lens' ListCachePoliciesResponse Int Source #

The response's http status code.

CreateCachePolicy

createCachePolicy_cachePolicyConfig :: Lens' CreateCachePolicy CachePolicyConfig Source #

A cache policy configuration.

createCachePolicyResponse_cachePolicy :: Lens' CreateCachePolicyResponse (Maybe CachePolicy) Source #

A cache policy.

createCachePolicyResponse_eTag :: Lens' CreateCachePolicyResponse (Maybe Text) Source #

The current version of the cache policy.

createCachePolicyResponse_location :: Lens' CreateCachePolicyResponse (Maybe Text) Source #

The fully qualified URI of the cache policy just created.

createCachePolicyResponse_httpStatus :: Lens' CreateCachePolicyResponse Int Source #

The response's http status code.

GetCachePolicyConfig

getCachePolicyConfig_id :: Lens' GetCachePolicyConfig Text Source #

The unique identifier for the cache policy. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.

getCachePolicyConfigResponse_eTag :: Lens' GetCachePolicyConfigResponse (Maybe Text) Source #

The current version of the cache policy.

getCachePolicyConfigResponse_cachePolicyConfig :: Lens' GetCachePolicyConfigResponse (Maybe CachePolicyConfig) Source #

The cache policy configuration.

getCachePolicyConfigResponse_httpStatus :: Lens' GetCachePolicyConfigResponse Int Source #

The response's http status code.

ListFieldLevelEncryptionConfigs

listFieldLevelEncryptionConfigs_marker :: Lens' ListFieldLevelEncryptionConfigs (Maybe Text) Source #

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).

listFieldLevelEncryptionConfigs_maxItems :: Lens' ListFieldLevelEncryptionConfigs (Maybe Text) Source #

The maximum number of field-level encryption configurations you want in the response body.

listFieldLevelEncryptionConfigsResponse_fieldLevelEncryptionList :: Lens' ListFieldLevelEncryptionConfigsResponse (Maybe FieldLevelEncryptionList) Source #

Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.

listFieldLevelEncryptionConfigsResponse_httpStatus :: Lens' ListFieldLevelEncryptionConfigsResponse Int Source #

The response's http status code.

ListDistributionsByKeyGroup

listDistributionsByKeyGroup_marker :: Lens' ListDistributionsByKeyGroup (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listDistributionsByKeyGroup_maxItems :: Lens' ListDistributionsByKeyGroup (Maybe Text) Source #

The maximum number of distribution IDs that you want in the response.

listDistributionsByKeyGroup_keyGroupId :: Lens' ListDistributionsByKeyGroup Text Source #

The ID of the key group whose associated distribution IDs you are listing.

listDistributionsByKeyGroupResponse_distributionIdList :: Lens' ListDistributionsByKeyGroupResponse (Maybe DistributionIdList) Source #

Undocumented member.

listDistributionsByKeyGroupResponse_httpStatus :: Lens' ListDistributionsByKeyGroupResponse Int Source #

The response's http status code.

TagResource

tagResource_resource :: Lens' TagResource Text Source #

An ARN of a CloudFront resource.

tagResource_tags :: Lens' TagResource Tags Source #

A complex type that contains zero or more Tag elements.

GetStreamingDistribution

getStreamingDistribution_id :: Lens' GetStreamingDistribution Text Source #

The streaming distribution's ID.

getStreamingDistributionResponse_eTag :: Lens' GetStreamingDistributionResponse (Maybe Text) Source #

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

getStreamingDistributionResponse_streamingDistribution :: Lens' GetStreamingDistributionResponse (Maybe StreamingDistribution) Source #

The streaming distribution's information.

getStreamingDistributionResponse_httpStatus :: Lens' GetStreamingDistributionResponse Int Source #

The response's http status code.

UpdateDistribution

updateDistribution_ifMatch :: Lens' UpdateDistribution (Maybe Text) Source #

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

updateDistribution_distributionConfig :: Lens' UpdateDistribution DistributionConfig Source #

The distribution's configuration information.

updateDistribution_id :: Lens' UpdateDistribution Text Source #

The distribution's id.

updateDistributionResponse_eTag :: Lens' UpdateDistributionResponse (Maybe Text) Source #

The current version of the configuration. For example: E2QWRUHAPOMQZL.

updateDistributionResponse_distribution :: Lens' UpdateDistributionResponse (Maybe Distribution) Source #

The distribution's information.

updateDistributionResponse_httpStatus :: Lens' UpdateDistributionResponse Int Source #

The response's http status code.

UpdateFunction

updateFunction_ifMatch :: Lens' UpdateFunction Text Source #

The current version (ETag value) of the function that you are updating, which you can get using DescribeFunction.

updateFunction_functionConfig :: Lens' UpdateFunction FunctionConfig Source #

Configuration information about the function.

updateFunction_functionCode :: Lens' UpdateFunction ByteString Source #

The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

updateFunction_name :: Lens' UpdateFunction Text Source #

The name of the function that you are updating.

updateFunctionResponse_eTag :: Lens' UpdateFunctionResponse (Maybe Text) Source #

The version identifier for the current version of the CloudFront function.

updateFunctionResponse_functionSummary :: Lens' UpdateFunctionResponse (Maybe FunctionSummary) Source #

Contains configuration information and metadata about a CloudFront function.

updateFunctionResponse_httpStatus :: Lens' UpdateFunctionResponse Int Source #

The response's http status code.

DeleteDistribution

deleteDistribution_ifMatch :: Lens' DeleteDistribution (Maybe Text) Source #

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

deleteDistribution_id :: Lens' DeleteDistribution Text Source #

The distribution ID.

DeleteFunction

deleteFunction_ifMatch :: Lens' DeleteFunction Text Source #

The current version (ETag value) of the function that you are deleting, which you can get using DescribeFunction.

deleteFunction_name :: Lens' DeleteFunction Text Source #

The name of the function that you are deleting.

GetOriginRequestPolicy

getOriginRequestPolicy_id :: Lens' GetOriginRequestPolicy Text Source #

The unique identifier for the origin request policy. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.

getOriginRequestPolicyResponse_eTag :: Lens' GetOriginRequestPolicyResponse (Maybe Text) Source #

The current version of the origin request policy.

getOriginRequestPolicyResponse_originRequestPolicy :: Lens' GetOriginRequestPolicyResponse (Maybe OriginRequestPolicy) Source #

The origin request policy.

getOriginRequestPolicyResponse_httpStatus :: Lens' GetOriginRequestPolicyResponse Int Source #

The response's http status code.

PublishFunction

publishFunction_name :: Lens' PublishFunction Text Source #

The name of the function that you are publishing.

publishFunction_ifMatch :: Lens' PublishFunction Text Source #

The current version (ETag value) of the function that you are publishing, which you can get using DescribeFunction.

publishFunctionResponse_functionSummary :: Lens' PublishFunctionResponse (Maybe FunctionSummary) Source #

Contains configuration information and metadata about a CloudFront function.

publishFunctionResponse_httpStatus :: Lens' PublishFunctionResponse Int Source #

The response's http status code.

UntagResource

untagResource_resource :: Lens' UntagResource Text Source #

An ARN of a CloudFront resource.

untagResource_tagKeys :: Lens' UntagResource TagKeys Source #

A complex type that contains zero or more Tag key elements.

CreateMonitoringSubscription

createMonitoringSubscription_monitoringSubscription :: Lens' CreateMonitoringSubscription MonitoringSubscription Source #

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

createMonitoringSubscription_distributionId :: Lens' CreateMonitoringSubscription Text Source #

The ID of the distribution that you are enabling metrics for.

createMonitoringSubscriptionResponse_monitoringSubscription :: Lens' CreateMonitoringSubscriptionResponse (Maybe MonitoringSubscription) Source #

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

createMonitoringSubscriptionResponse_httpStatus :: Lens' CreateMonitoringSubscriptionResponse Int Source #

The response's http status code.

ListDistributionsByWebACLId

listDistributionsByWebACLId_marker :: Lens' ListDistributionsByWebACLId (Maybe Text) Source #

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

listDistributionsByWebACLId_maxItems :: Lens' ListDistributionsByWebACLId (Maybe Text) Source #

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

listDistributionsByWebACLId_webACLId :: Lens' ListDistributionsByWebACLId Text Source #

The ID of the WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

listDistributionsByWebACLIdResponse_distributionList :: Lens' ListDistributionsByWebACLIdResponse (Maybe DistributionList) Source #

The DistributionList type.

listDistributionsByWebACLIdResponse_httpStatus :: Lens' ListDistributionsByWebACLIdResponse Int Source #

The response's http status code.

ListDistributions

listDistributions_marker :: Lens' ListDistributions (Maybe Text) Source #

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

listDistributions_maxItems :: Lens' ListDistributions (Maybe Text) Source #

The maximum number of distributions you want in the response body.

listDistributionsResponse_httpStatus :: Lens' ListDistributionsResponse Int Source #

The response's http status code.

listDistributionsResponse_distributionList :: Lens' ListDistributionsResponse DistributionList Source #

The DistributionList type.

ListFunctions

listFunctions_stage :: Lens' ListFunctions (Maybe FunctionStage) Source #

An optional filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE.

listFunctions_marker :: Lens' ListFunctions (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of functions. The response includes functions in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listFunctions_maxItems :: Lens' ListFunctions (Maybe Text) Source #

The maximum number of functions that you want in the response.

listFunctionsResponse_functionList :: Lens' ListFunctionsResponse (Maybe FunctionList) Source #

A list of CloudFront functions.

listFunctionsResponse_httpStatus :: Lens' ListFunctionsResponse Int Source #

The response's http status code.

ListDistributionsByRealtimeLogConfig

listDistributionsByRealtimeLogConfig_realtimeLogConfigName :: Lens' ListDistributionsByRealtimeLogConfig (Maybe Text) Source #

The name of the real-time log configuration whose associated distributions you want to list.

listDistributionsByRealtimeLogConfig_realtimeLogConfigArn :: Lens' ListDistributionsByRealtimeLogConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.

listDistributionsByRealtimeLogConfig_marker :: Lens' ListDistributionsByRealtimeLogConfig (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of distributions. The response includes distributions in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listDistributionsByRealtimeLogConfig_maxItems :: Lens' ListDistributionsByRealtimeLogConfig (Maybe Text) Source #

The maximum number of distributions that you want in the response.

listDistributionsByRealtimeLogConfigResponse_distributionList :: Lens' ListDistributionsByRealtimeLogConfigResponse (Maybe DistributionList) Source #

Undocumented member.

listDistributionsByRealtimeLogConfigResponse_httpStatus :: Lens' ListDistributionsByRealtimeLogConfigResponse Int Source #

The response's http status code.

CreateOriginRequestPolicy

createOriginRequestPolicy_originRequestPolicyConfig :: Lens' CreateOriginRequestPolicy OriginRequestPolicyConfig Source #

An origin request policy configuration.

createOriginRequestPolicyResponse_eTag :: Lens' CreateOriginRequestPolicyResponse (Maybe Text) Source #

The current version of the origin request policy.

createOriginRequestPolicyResponse_location :: Lens' CreateOriginRequestPolicyResponse (Maybe Text) Source #

The fully qualified URI of the origin request policy just created.

createOriginRequestPolicyResponse_originRequestPolicy :: Lens' CreateOriginRequestPolicyResponse (Maybe OriginRequestPolicy) Source #

An origin request policy.

createOriginRequestPolicyResponse_httpStatus :: Lens' CreateOriginRequestPolicyResponse Int Source #

The response's http status code.

ListKeyGroups

listKeyGroups_marker :: Lens' ListKeyGroups (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listKeyGroups_maxItems :: Lens' ListKeyGroups (Maybe Text) Source #

The maximum number of key groups that you want in the response.

listKeyGroupsResponse_keyGroupList :: Lens' ListKeyGroupsResponse (Maybe KeyGroupList) Source #

A list of key groups.

listKeyGroupsResponse_httpStatus :: Lens' ListKeyGroupsResponse Int Source #

The response's http status code.

ListFieldLevelEncryptionProfiles

listFieldLevelEncryptionProfiles_marker :: Lens' ListFieldLevelEncryptionProfiles (Maybe Text) Source #

Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).

listFieldLevelEncryptionProfiles_maxItems :: Lens' ListFieldLevelEncryptionProfiles (Maybe Text) Source #

The maximum number of field-level encryption profiles you want in the response body.

listFieldLevelEncryptionProfilesResponse_fieldLevelEncryptionProfileList :: Lens' ListFieldLevelEncryptionProfilesResponse (Maybe FieldLevelEncryptionProfileList) Source #

Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.

listFieldLevelEncryptionProfilesResponse_httpStatus :: Lens' ListFieldLevelEncryptionProfilesResponse Int Source #

The response's http status code.

GetMonitoringSubscription

getMonitoringSubscription_distributionId :: Lens' GetMonitoringSubscription Text Source #

The ID of the distribution that you are getting metrics information for.

getMonitoringSubscriptionResponse_monitoringSubscription :: Lens' GetMonitoringSubscriptionResponse (Maybe MonitoringSubscription) Source #

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

getMonitoringSubscriptionResponse_httpStatus :: Lens' GetMonitoringSubscriptionResponse Int Source #

The response's http status code.

UpdateKeyGroup

updateKeyGroup_ifMatch :: Lens' UpdateKeyGroup (Maybe Text) Source #

The version of the key group that you are updating. The version is the key group’s ETag value.

updateKeyGroup_keyGroupConfig :: Lens' UpdateKeyGroup KeyGroupConfig Source #

The key group configuration.

updateKeyGroup_id :: Lens' UpdateKeyGroup Text Source #

The identifier of the key group that you are updating.

updateKeyGroupResponse_eTag :: Lens' UpdateKeyGroupResponse (Maybe Text) Source #

The identifier for this version of the key group.

updateKeyGroupResponse_keyGroup :: Lens' UpdateKeyGroupResponse (Maybe KeyGroup) Source #

The key group that was just updated.

updateKeyGroupResponse_httpStatus :: Lens' UpdateKeyGroupResponse Int Source #

The response's http status code.

DeleteKeyGroup

deleteKeyGroup_ifMatch :: Lens' DeleteKeyGroup (Maybe Text) Source #

The version of the key group that you are deleting. The version is the key group’s ETag value. To get the ETag, use GetKeyGroup or GetKeyGroupConfig.

deleteKeyGroup_id :: Lens' DeleteKeyGroup Text Source #

The identifier of the key group that you are deleting. To get the identifier, use ListKeyGroups.

ListOriginRequestPolicies

listOriginRequestPolicies_marker :: Lens' ListOriginRequestPolicies (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of origin request policies. The response includes origin request policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listOriginRequestPolicies_maxItems :: Lens' ListOriginRequestPolicies (Maybe Text) Source #

The maximum number of origin request policies that you want in the response.

listOriginRequestPolicies_type :: Lens' ListOriginRequestPolicies (Maybe OriginRequestPolicyType) Source #

A filter to return only the specified kinds of origin request policies. Valid values are:

  • managed – Returns only the managed policies created by Amazon Web Services.
  • custom – Returns only the custom policies created in your account.

listOriginRequestPoliciesResponse_originRequestPolicyList :: Lens' ListOriginRequestPoliciesResponse (Maybe OriginRequestPolicyList) Source #

A list of origin request policies.

listOriginRequestPoliciesResponse_httpStatus :: Lens' ListOriginRequestPoliciesResponse Int Source #

The response's http status code.

GetOriginRequestPolicyConfig

getOriginRequestPolicyConfig_id :: Lens' GetOriginRequestPolicyConfig Text Source #

The unique identifier for the origin request policy. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.

getOriginRequestPolicyConfigResponse_eTag :: Lens' GetOriginRequestPolicyConfigResponse (Maybe Text) Source #

The current version of the origin request policy.

getOriginRequestPolicyConfigResponse_originRequestPolicyConfig :: Lens' GetOriginRequestPolicyConfigResponse (Maybe OriginRequestPolicyConfig) Source #

The origin request policy configuration.

getOriginRequestPolicyConfigResponse_httpStatus :: Lens' GetOriginRequestPolicyConfigResponse Int Source #

The response's http status code.

Types

ActiveTrustedKeyGroups

activeTrustedKeyGroups_items :: Lens' ActiveTrustedKeyGroups (Maybe [KGKeyPairIds]) Source #

A list of key groups, including the identifiers of the public keys in each key group that CloudFront can use to verify the signatures of signed URLs and signed cookies.

activeTrustedKeyGroups_enabled :: Lens' ActiveTrustedKeyGroups Bool Source #

This field is true if any of the key groups have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

activeTrustedKeyGroups_quantity :: Lens' ActiveTrustedKeyGroups Int Source #

The number of key groups in the list.

ActiveTrustedSigners

activeTrustedSigners_items :: Lens' ActiveTrustedSigners (Maybe [Signer]) Source #

A list of accounts and the identifiers of active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.

activeTrustedSigners_enabled :: Lens' ActiveTrustedSigners Bool Source #

This field is true if any of the accounts in the list have active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

activeTrustedSigners_quantity :: Lens' ActiveTrustedSigners Int Source #

The number of accounts in the list.

AliasICPRecordal

aliasICPRecordal_cname :: Lens' AliasICPRecordal (Maybe Text) Source #

A domain name associated with a distribution.

aliasICPRecordal_iCPRecordalStatus :: Lens' AliasICPRecordal (Maybe ICPRecordalStatus) Source #

The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

The status values returned are the following:

  • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.
  • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.
  • PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.

Aliases

aliases_items :: Lens' Aliases (Maybe [Text]) Source #

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

aliases_quantity :: Lens' Aliases Int Source #

The number of CNAME aliases, if any, that you want to associate with this distribution.

AllowedMethods

allowedMethods_cachedMethods :: Lens' AllowedMethods (Maybe CachedMethods) Source #

Undocumented member.

allowedMethods_quantity :: Lens' AllowedMethods Int Source #

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

allowedMethods_items :: Lens' AllowedMethods [Method] Source #

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

CacheBehavior

cacheBehavior_allowedMethods :: Lens' CacheBehavior (Maybe AllowedMethods) Source #

Undocumented member.

cacheBehavior_lambdaFunctionAssociations :: Lens' CacheBehavior (Maybe LambdaFunctionAssociations) Source #

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

cacheBehavior_maxTTL :: Lens' CacheBehavior (Maybe Integer) Source #

This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

cacheBehavior_minTTL :: Lens' CacheBehavior (Maybe Integer) Source #

This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

cacheBehavior_compress :: Lens' CacheBehavior (Maybe Bool) Source #

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

cacheBehavior_smoothStreaming :: Lens' CacheBehavior (Maybe Bool) Source #

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

cacheBehavior_trustedKeyGroups :: Lens' CacheBehavior (Maybe TrustedKeyGroups) Source #

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted key groups, 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.

cacheBehavior_realtimeLogConfigArn :: Lens' CacheBehavior (Maybe Text) Source #

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

cacheBehavior_defaultTTL :: Lens' CacheBehavior (Maybe Integer) Source #

This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

cacheBehavior_forwardedValues :: Lens' CacheBehavior (Maybe ForwardedValues) Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.

If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

cacheBehavior_trustedSigners :: Lens' CacheBehavior (Maybe TrustedSigners) Source #

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s account. 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.

cacheBehavior_functionAssociations :: Lens' CacheBehavior (Maybe FunctionAssociations) Source #

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

cacheBehavior_originRequestPolicyId :: Lens' CacheBehavior (Maybe Text) Source #

The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

cacheBehavior_fieldLevelEncryptionId :: Lens' CacheBehavior (Maybe Text) Source #

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.

cacheBehavior_cachePolicyId :: Lens' CacheBehavior (Maybe Text) Source #

The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

cacheBehavior_pathPattern :: Lens' CacheBehavior Text Source #

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

cacheBehavior_targetOriginId :: Lens' CacheBehavior Text Source #

The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

cacheBehavior_viewerProtocolPolicy :: Lens' CacheBehavior ViewerProtocolPolicy Source #

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.
  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.
  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.

CacheBehaviors

cacheBehaviors_items :: Lens' CacheBehaviors (Maybe [CacheBehavior]) Source #

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

cacheBehaviors_quantity :: Lens' CacheBehaviors Int Source #

The number of cache behaviors for this distribution.

CachePolicy

cachePolicy_id :: Lens' CachePolicy Text Source #

The unique identifier for the cache policy.

cachePolicy_lastModifiedTime :: Lens' CachePolicy UTCTime Source #

The date and time when the cache policy was last modified.

cachePolicy_cachePolicyConfig :: Lens' CachePolicy CachePolicyConfig Source #

The cache policy configuration.

CachePolicyConfig

cachePolicyConfig_maxTTL :: Lens' CachePolicyConfig (Maybe Integer) Source #

The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.

cachePolicyConfig_parametersInCacheKeyAndForwardedToOrigin :: Lens' CachePolicyConfig (Maybe ParametersInCacheKeyAndForwardedToOrigin) Source #

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

cachePolicyConfig_defaultTTL :: Lens' CachePolicyConfig (Maybe Integer) Source #

The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.

cachePolicyConfig_comment :: Lens' CachePolicyConfig (Maybe Text) Source #

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

cachePolicyConfig_name :: Lens' CachePolicyConfig Text Source #

A unique name to identify the cache policy.

cachePolicyConfig_minTTL :: Lens' CachePolicyConfig Integer Source #

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

CachePolicyCookiesConfig

cachePolicyCookiesConfig_cookies :: Lens' CachePolicyCookiesConfig (Maybe CookieNames) Source #

Undocumented member.

cachePolicyCookiesConfig_cookieBehavior :: Lens' CachePolicyCookiesConfig CachePolicyCookieBehavior Source #

Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

  • none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in an OriginRequestPolicy are included in origin requests.
  • whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  • allExcept – All cookies in viewer requests that are not listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  • all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

CachePolicyHeadersConfig

cachePolicyHeadersConfig_headers :: Lens' CachePolicyHeadersConfig (Maybe Headers) Source #

Undocumented member.

cachePolicyHeadersConfig_headerBehavior :: Lens' CachePolicyHeadersConfig CachePolicyHeaderBehavior Source #

Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

  • none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.
  • whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

CachePolicyList

cachePolicyList_items :: Lens' CachePolicyList (Maybe [CachePolicySummary]) Source #

Contains the cache policies in the list.

cachePolicyList_nextMarker :: Lens' CachePolicyList (Maybe Text) Source #

If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing cache policies where you left off.

cachePolicyList_maxItems :: Lens' CachePolicyList Int Source #

The maximum number of cache policies requested.

cachePolicyList_quantity :: Lens' CachePolicyList Int Source #

The total number of cache policies returned in the response.

CachePolicyQueryStringsConfig

cachePolicyQueryStringsConfig_queryStrings :: Lens' CachePolicyQueryStringsConfig (Maybe QueryStringNames) Source #

Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

cachePolicyQueryStringsConfig_queryStringBehavior :: Lens' CachePolicyQueryStringsConfig CachePolicyQueryStringBehavior Source #

Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

  • none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in an OriginRequestPolicy are included in origin requests.
  • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  • allExcept – All query strings in viewer requests that are not listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  • all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

CachePolicySummary

cachePolicySummary_type :: Lens' CachePolicySummary CachePolicyType Source #

The type of cache policy, either managed (created by Amazon Web Services) or custom (created in this account).

cachePolicySummary_cachePolicy :: Lens' CachePolicySummary CachePolicy Source #

The cache policy.

CachedMethods

cachedMethods_quantity :: Lens' CachedMethods Int Source #

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

cachedMethods_items :: Lens' CachedMethods [Method] Source #

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

CloudFrontOriginAccessIdentity

cloudFrontOriginAccessIdentity_cloudFrontOriginAccessIdentityConfig :: Lens' CloudFrontOriginAccessIdentity (Maybe CloudFrontOriginAccessIdentityConfig) Source #

The current configuration information for the identity.

cloudFrontOriginAccessIdentity_id :: Lens' CloudFrontOriginAccessIdentity Text Source #

The ID for the origin access identity, for example, E74FTE3AJFJ256A.

cloudFrontOriginAccessIdentity_s3CanonicalUserId :: Lens' CloudFrontOriginAccessIdentity Text Source #

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

CloudFrontOriginAccessIdentityConfig

cloudFrontOriginAccessIdentityConfig_callerReference :: Lens' CloudFrontOriginAccessIdentityConfig Text Source #

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

cloudFrontOriginAccessIdentityConfig_comment :: Lens' CloudFrontOriginAccessIdentityConfig Text Source #

A comment to describe the origin access identity. The comment cannot be longer than 128 characters.

CloudFrontOriginAccessIdentityList

cloudFrontOriginAccessIdentityList_items :: Lens' CloudFrontOriginAccessIdentityList (Maybe [CloudFrontOriginAccessIdentitySummary]) Source #

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current account.

cloudFrontOriginAccessIdentityList_nextMarker :: Lens' CloudFrontOriginAccessIdentityList (Maybe Text) Source #

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

cloudFrontOriginAccessIdentityList_marker :: Lens' CloudFrontOriginAccessIdentityList Text Source #

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

cloudFrontOriginAccessIdentityList_maxItems :: Lens' CloudFrontOriginAccessIdentityList Int Source #

The maximum number of origin access identities you want in the response body.

cloudFrontOriginAccessIdentityList_isTruncated :: Lens' CloudFrontOriginAccessIdentityList Bool Source #

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

cloudFrontOriginAccessIdentityList_quantity :: Lens' CloudFrontOriginAccessIdentityList Int Source #

The number of CloudFront origin access identities that were created by the current account.

CloudFrontOriginAccessIdentitySummary

cloudFrontOriginAccessIdentitySummary_id :: Lens' CloudFrontOriginAccessIdentitySummary Text Source #

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

cloudFrontOriginAccessIdentitySummary_s3CanonicalUserId :: Lens' CloudFrontOriginAccessIdentitySummary Text Source #

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

cloudFrontOriginAccessIdentitySummary_comment :: Lens' CloudFrontOriginAccessIdentitySummary Text Source #

The comment for this origin access identity, as originally specified when created.

ConflictingAlias

conflictingAlias_alias :: Lens' ConflictingAlias (Maybe Text) Source #

An alias (also called a CNAME).

conflictingAlias_accountId :: Lens' ConflictingAlias (Maybe Text) Source #

The (partially hidden) ID of the Amazon Web Services account that owns the distribution that’s associated with the alias.

conflictingAlias_distributionId :: Lens' ConflictingAlias (Maybe Text) Source #

The (partially hidden) ID of the CloudFront distribution associated with the alias.

ConflictingAliasesList

conflictingAliasesList_quantity :: Lens' ConflictingAliasesList (Maybe Int) Source #

The number of conflicting aliases returned in the response.

conflictingAliasesList_items :: Lens' ConflictingAliasesList (Maybe [ConflictingAlias]) Source #

Contains the conflicting aliases in the list.

conflictingAliasesList_maxItems :: Lens' ConflictingAliasesList (Maybe Int) Source #

The maximum number of conflicting aliases requested.

conflictingAliasesList_nextMarker :: Lens' ConflictingAliasesList (Maybe Text) Source #

If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing conflicting aliases where you left off.

ContentTypeProfile

contentTypeProfile_profileId :: Lens' ContentTypeProfile (Maybe Text) Source #

The profile ID for a field-level encryption content type-profile mapping.

contentTypeProfile_format :: Lens' ContentTypeProfile Format Source #

The format for a field-level encryption content type-profile mapping.

contentTypeProfile_contentType :: Lens' ContentTypeProfile Text Source #

The content type for a field-level encryption content type-profile mapping.

ContentTypeProfileConfig

contentTypeProfileConfig_contentTypeProfiles :: Lens' ContentTypeProfileConfig (Maybe ContentTypeProfiles) Source #

The configuration for a field-level encryption content type-profile.

contentTypeProfileConfig_forwardWhenContentTypeIsUnknown :: Lens' ContentTypeProfileConfig Bool Source #

The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.

ContentTypeProfiles

contentTypeProfiles_items :: Lens' ContentTypeProfiles (Maybe [ContentTypeProfile]) Source #

Items in a field-level encryption content type-profile mapping.

contentTypeProfiles_quantity :: Lens' ContentTypeProfiles Int Source #

The number of field-level encryption content type-profile mappings.

CookieNames

cookieNames_items :: Lens' CookieNames (Maybe [Text]) Source #

A list of cookie names.

cookieNames_quantity :: Lens' CookieNames Int Source #

The number of cookie names in the Items list.

CookiePreference

cookiePreference_whitelistedNames :: Lens' CookiePreference (Maybe CookieNames) Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

Required if you specify whitelist for the value of Forward. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the Amazon Web Services General Reference.

cookiePreference_forward :: Lens' CookiePreference ItemSelection Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

CustomErrorResponse

customErrorResponse_responsePagePath :: Lens' CustomErrorResponse (Maybe Text) Source #

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.
  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

customErrorResponse_responseCode :: Lens' CustomErrorResponse (Maybe Text) Source #

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.
  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.
  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath.

customErrorResponse_errorCachingMinTTL :: Lens' CustomErrorResponse (Maybe Integer) Source #

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

customErrorResponse_errorCode :: Lens' CustomErrorResponse Int Source #

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

CustomErrorResponses

customErrorResponses_items :: Lens' CustomErrorResponses (Maybe [CustomErrorResponse]) Source #

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

customErrorResponses_quantity :: Lens' CustomErrorResponses Int Source #

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

CustomHeaders

customHeaders_items :: Lens' CustomHeaders (Maybe [OriginCustomHeader]) Source #

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

customHeaders_quantity :: Lens' CustomHeaders Int Source #

The number of custom headers, if any, for this distribution.

CustomOriginConfig

customOriginConfig_originKeepaliveTimeout :: Lens' CustomOriginConfig (Maybe Int) Source #

Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 5 seconds.

For more information, see Origin Keep-alive Timeout in the Amazon CloudFront Developer Guide.

customOriginConfig_originReadTimeout :: Lens' CustomOriginConfig (Maybe Int) Source #

Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.

For more information, see Origin Response Timeout in the Amazon CloudFront Developer Guide.

customOriginConfig_originSslProtocols :: Lens' CustomOriginConfig (Maybe OriginSslProtocols) Source #

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2.

For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.

customOriginConfig_hTTPPort :: Lens' CustomOriginConfig Int Source #

The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.

customOriginConfig_hTTPSPort :: Lens' CustomOriginConfig Int Source #

The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.

customOriginConfig_originProtocolPolicy :: Lens' CustomOriginConfig OriginProtocolPolicy Source #

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:

  • http-only – CloudFront always uses HTTP to connect to the origin.
  • match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.
  • https-only – CloudFront always uses HTTPS to connect to the origin.

DefaultCacheBehavior

defaultCacheBehavior_allowedMethods :: Lens' DefaultCacheBehavior (Maybe AllowedMethods) Source #

Undocumented member.

defaultCacheBehavior_lambdaFunctionAssociations :: Lens' DefaultCacheBehavior (Maybe LambdaFunctionAssociations) Source #

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

defaultCacheBehavior_maxTTL :: Lens' DefaultCacheBehavior (Maybe Integer) Source #

This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

defaultCacheBehavior_minTTL :: Lens' DefaultCacheBehavior (Maybe Integer) Source #

This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

defaultCacheBehavior_compress :: Lens' DefaultCacheBehavior (Maybe Bool) Source #

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

defaultCacheBehavior_smoothStreaming :: Lens' DefaultCacheBehavior (Maybe Bool) Source #

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

defaultCacheBehavior_trustedKeyGroups :: Lens' DefaultCacheBehavior (Maybe TrustedKeyGroups) Source #

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted key groups, 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.

defaultCacheBehavior_realtimeLogConfigArn :: Lens' DefaultCacheBehavior (Maybe Text) Source #

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

defaultCacheBehavior_defaultTTL :: Lens' DefaultCacheBehavior (Maybe Integer) Source #

This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

defaultCacheBehavior_forwardedValues :: Lens' DefaultCacheBehavior (Maybe ForwardedValues) Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see Working with policies in the Amazon CloudFront Developer Guide.

If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

defaultCacheBehavior_trustedSigners :: Lens' DefaultCacheBehavior (Maybe TrustedSigners) Source #

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer’s account. 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.

defaultCacheBehavior_functionAssociations :: Lens' DefaultCacheBehavior (Maybe FunctionAssociations) Source #

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

defaultCacheBehavior_originRequestPolicyId :: Lens' DefaultCacheBehavior (Maybe Text) Source #

The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

defaultCacheBehavior_fieldLevelEncryptionId :: Lens' DefaultCacheBehavior (Maybe Text) Source #

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.

defaultCacheBehavior_cachePolicyId :: Lens' DefaultCacheBehavior (Maybe Text) Source #

The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

defaultCacheBehavior_targetOriginId :: Lens' DefaultCacheBehavior Text Source #

The value of ID for the origin that you want CloudFront to route requests to when they use the default cache behavior.

defaultCacheBehavior_viewerProtocolPolicy :: Lens' DefaultCacheBehavior ViewerProtocolPolicy Source #

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.
  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.
  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.

Distribution

distribution_activeTrustedKeyGroups :: Lens' Distribution (Maybe ActiveTrustedKeyGroups) Source #

CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.

distribution_aliasICPRecordals :: Lens' Distribution (Maybe [AliasICPRecordal]) Source #

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

distribution_activeTrustedSigners :: Lens' Distribution (Maybe ActiveTrustedSigners) Source #

We recommend using TrustedKeyGroups instead of TrustedSigners.

CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.

distribution_id :: Lens' Distribution Text Source #

The identifier for the distribution. For example: EDFDVBD632BHDS5.

distribution_arn :: Lens' Distribution Text Source #

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your account ID.

distribution_status :: Lens' Distribution Text Source #

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

distribution_lastModifiedTime :: Lens' Distribution UTCTime Source #

The date and time the distribution was last modified.

distribution_inProgressInvalidationBatches :: Lens' Distribution Int Source #

The number of invalidation batches currently in progress.

distribution_domainName :: Lens' Distribution Text Source #

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

distribution_distributionConfig :: Lens' Distribution DistributionConfig Source #

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

DistributionConfig

distributionConfig_httpVersion :: Lens' DistributionConfig (Maybe HttpVersion) Source #

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."

distributionConfig_originGroups :: Lens' DistributionConfig (Maybe OriginGroups) Source #

A complex type that contains information about origin groups for this distribution.

distributionConfig_aliases :: Lens' DistributionConfig (Maybe Aliases) Source #

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

distributionConfig_defaultRootObject :: Lens' DistributionConfig (Maybe Text) Source #

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Don't add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

distributionConfig_priceClass :: Lens' DistributionConfig (Maybe PriceClass) Source #

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

distributionConfig_customErrorResponses :: Lens' DistributionConfig (Maybe CustomErrorResponses) Source #

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.
  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

distributionConfig_webACLId :: Lens' DistributionConfig (Maybe Text) Source #

A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a.

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide.

distributionConfig_viewerCertificate :: Lens' DistributionConfig (Maybe ViewerCertificate) Source #

A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.

distributionConfig_restrictions :: Lens' DistributionConfig (Maybe Restrictions) Source #

A complex type that identifies ways in which you want to restrict distribution of your content.

distributionConfig_logging :: Lens' DistributionConfig (Maybe LoggingConfig) Source #

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

distributionConfig_cacheBehaviors :: Lens' DistributionConfig (Maybe CacheBehaviors) Source #

A complex type that contains zero or more CacheBehavior elements.

distributionConfig_isIPV6Enabled :: Lens' DistributionConfig (Maybe Bool) Source #

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution
  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide.

If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

distributionConfig_callerReference :: Lens' DistributionConfig Text Source #

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

distributionConfig_origins :: Lens' DistributionConfig Origins Source #

A complex type that contains information about origins for this distribution.

distributionConfig_defaultCacheBehavior :: Lens' DistributionConfig DefaultCacheBehavior Source #

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

distributionConfig_comment :: Lens' DistributionConfig Text Source #

An optional comment to describe the distribution. The comment cannot be longer than 128 characters.

distributionConfig_enabled :: Lens' DistributionConfig Bool Source #

From this field, you can enable or disable the selected distribution.

DistributionConfigWithTags

distributionConfigWithTags_distributionConfig :: Lens' DistributionConfigWithTags DistributionConfig Source #

A distribution configuration.

distributionConfigWithTags_tags :: Lens' DistributionConfigWithTags Tags Source #

A complex type that contains zero or more Tag elements.

DistributionIdList

distributionIdList_items :: Lens' DistributionIdList (Maybe [Text]) Source #

Contains the distribution IDs in the list.

distributionIdList_nextMarker :: Lens' DistributionIdList (Maybe Text) Source #

Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off.

distributionIdList_marker :: Lens' DistributionIdList Text Source #

The value provided in the Marker request field.

distributionIdList_maxItems :: Lens' DistributionIdList Int Source #

The maximum number of distribution IDs requested.

distributionIdList_isTruncated :: Lens' DistributionIdList Bool Source #

A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can make a subsequent request using the Marker request field to retrieve more distribution IDs in the list.

distributionIdList_quantity :: Lens' DistributionIdList Int Source #

The total number of distribution IDs returned in the response.

DistributionList

distributionList_items :: Lens' DistributionList (Maybe [DistributionSummary]) Source #

A complex type that contains one DistributionSummary element for each distribution that was created by the current account.

distributionList_nextMarker :: Lens' DistributionList (Maybe Text) Source #

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

distributionList_marker :: Lens' DistributionList Text Source #

The value you provided for the Marker request parameter.

distributionList_maxItems :: Lens' DistributionList Int Source #

The value you provided for the MaxItems request parameter.

distributionList_isTruncated :: Lens' DistributionList Bool Source #

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

distributionList_quantity :: Lens' DistributionList Int Source #

The number of distributions that were created by the current account.

DistributionSummary

distributionSummary_originGroups :: Lens' DistributionSummary (Maybe OriginGroups) Source #

A complex type that contains information about origin groups for this distribution.

distributionSummary_aliasICPRecordals :: Lens' DistributionSummary (Maybe [AliasICPRecordal]) Source #

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

distributionSummary_id :: Lens' DistributionSummary Text Source #

The identifier for the distribution. For example: EDFDVBD632BHDS5.

distributionSummary_arn :: Lens' DistributionSummary Text Source #

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your account ID.

distributionSummary_status :: Lens' DistributionSummary Text Source #

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

distributionSummary_lastModifiedTime :: Lens' DistributionSummary UTCTime Source #

The date and time the distribution was last modified.

distributionSummary_domainName :: Lens' DistributionSummary Text Source #

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

distributionSummary_aliases :: Lens' DistributionSummary Aliases Source #

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

distributionSummary_origins :: Lens' DistributionSummary Origins Source #

A complex type that contains information about origins for this distribution.

distributionSummary_defaultCacheBehavior :: Lens' DistributionSummary DefaultCacheBehavior Source #

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

distributionSummary_cacheBehaviors :: Lens' DistributionSummary CacheBehaviors Source #

A complex type that contains zero or more CacheBehavior elements.

distributionSummary_customErrorResponses :: Lens' DistributionSummary CustomErrorResponses Source #

A complex type that contains zero or more CustomErrorResponses elements.

distributionSummary_comment :: Lens' DistributionSummary Text Source #

The comment originally specified when this distribution was created.

distributionSummary_priceClass :: Lens' DistributionSummary PriceClass Source #

A complex type that contains information about price class for this streaming distribution.

distributionSummary_enabled :: Lens' DistributionSummary Bool Source #

Whether the distribution is enabled to accept user requests for content.

distributionSummary_viewerCertificate :: Lens' DistributionSummary ViewerCertificate Source #

A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.

distributionSummary_restrictions :: Lens' DistributionSummary Restrictions Source #

A complex type that identifies ways in which you want to restrict distribution of your content.

distributionSummary_webACLId :: Lens' DistributionSummary Text Source #

The Web ACL Id (if any) associated with the distribution.

distributionSummary_httpVersion :: Lens' DistributionSummary HttpVersion Source #

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

distributionSummary_isIPV6Enabled :: Lens' DistributionSummary Bool Source #

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

EncryptionEntities

encryptionEntities_items :: Lens' EncryptionEntities (Maybe [EncryptionEntity]) Source #

An array of field patterns in a field-level encryption content type-profile mapping.

encryptionEntities_quantity :: Lens' EncryptionEntities Int Source #

Number of field pattern items in a field-level encryption content type-profile mapping.

EncryptionEntity

encryptionEntity_publicKeyId :: Lens' EncryptionEntity Text Source #

The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.

encryptionEntity_providerId :: Lens' EncryptionEntity Text Source #

The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.

encryptionEntity_fieldPatterns :: Lens' EncryptionEntity FieldPatterns Source #

Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.

EndPoint

endPoint_kinesisStreamConfig :: Lens' EndPoint (Maybe KinesisStreamConfig) Source #

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

endPoint_streamType :: Lens' EndPoint Text Source #

The type of data stream where you are sending real-time log data. The only valid value is Kinesis.

FieldLevelEncryption

fieldLevelEncryption_id :: Lens' FieldLevelEncryption Text Source #

The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

fieldLevelEncryption_lastModifiedTime :: Lens' FieldLevelEncryption UTCTime Source #

The last time the field-level encryption configuration was changed.

fieldLevelEncryption_fieldLevelEncryptionConfig :: Lens' FieldLevelEncryption FieldLevelEncryptionConfig Source #

A complex data type that includes the profile configurations specified for field-level encryption.

FieldLevelEncryptionConfig

fieldLevelEncryptionConfig_queryArgProfileConfig :: Lens' FieldLevelEncryptionConfig (Maybe QueryArgProfileConfig) Source #

A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.

fieldLevelEncryptionConfig_contentTypeProfileConfig :: Lens' FieldLevelEncryptionConfig (Maybe ContentTypeProfileConfig) Source #

A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.

fieldLevelEncryptionConfig_comment :: Lens' FieldLevelEncryptionConfig (Maybe Text) Source #

An optional comment about the configuration. The comment cannot be longer than 128 characters.

fieldLevelEncryptionConfig_callerReference :: Lens' FieldLevelEncryptionConfig Text Source #

A unique number that ensures the request can't be replayed.

FieldLevelEncryptionList

fieldLevelEncryptionList_items :: Lens' FieldLevelEncryptionList (Maybe [FieldLevelEncryptionSummary]) Source #

An array of field-level encryption items.

fieldLevelEncryptionList_nextMarker :: Lens' FieldLevelEncryptionList (Maybe Text) Source #

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.

fieldLevelEncryptionList_maxItems :: Lens' FieldLevelEncryptionList Int Source #

The maximum number of elements you want in the response body.

fieldLevelEncryptionList_quantity :: Lens' FieldLevelEncryptionList Int Source #

The number of field-level encryption items.

FieldLevelEncryptionProfile

fieldLevelEncryptionProfile_id :: Lens' FieldLevelEncryptionProfile Text Source #

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

fieldLevelEncryptionProfile_lastModifiedTime :: Lens' FieldLevelEncryptionProfile UTCTime Source #

The last time the field-level encryption profile was updated.

fieldLevelEncryptionProfile_fieldLevelEncryptionProfileConfig :: Lens' FieldLevelEncryptionProfile FieldLevelEncryptionProfileConfig Source #

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

FieldLevelEncryptionProfileConfig

fieldLevelEncryptionProfileConfig_comment :: Lens' FieldLevelEncryptionProfileConfig (Maybe Text) Source #

An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.

fieldLevelEncryptionProfileConfig_name :: Lens' FieldLevelEncryptionProfileConfig Text Source #

Profile name for the field-level encryption profile.

fieldLevelEncryptionProfileConfig_callerReference :: Lens' FieldLevelEncryptionProfileConfig Text Source #

A unique number that ensures that the request can't be replayed.

fieldLevelEncryptionProfileConfig_encryptionEntities :: Lens' FieldLevelEncryptionProfileConfig EncryptionEntities Source #

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

FieldLevelEncryptionProfileList

fieldLevelEncryptionProfileList_items :: Lens' FieldLevelEncryptionProfileList (Maybe [FieldLevelEncryptionProfileSummary]) Source #

The field-level encryption profile items.

fieldLevelEncryptionProfileList_nextMarker :: Lens' FieldLevelEncryptionProfileList (Maybe Text) Source #

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off.

fieldLevelEncryptionProfileList_maxItems :: Lens' FieldLevelEncryptionProfileList Int Source #

The maximum number of field-level encryption profiles you want in the response body.

fieldLevelEncryptionProfileList_quantity :: Lens' FieldLevelEncryptionProfileList Int Source #

The number of field-level encryption profiles.

FieldLevelEncryptionProfileSummary

fieldLevelEncryptionProfileSummary_comment :: Lens' FieldLevelEncryptionProfileSummary (Maybe Text) Source #

An optional comment for the field-level encryption profile summary. The comment cannot be longer than 128 characters.

fieldLevelEncryptionProfileSummary_id :: Lens' FieldLevelEncryptionProfileSummary Text Source #

ID for the field-level encryption profile summary.

fieldLevelEncryptionProfileSummary_lastModifiedTime :: Lens' FieldLevelEncryptionProfileSummary UTCTime Source #

The time when the the field-level encryption profile summary was last updated.

fieldLevelEncryptionProfileSummary_name :: Lens' FieldLevelEncryptionProfileSummary Text Source #

Name for the field-level encryption profile summary.

fieldLevelEncryptionProfileSummary_encryptionEntities :: Lens' FieldLevelEncryptionProfileSummary EncryptionEntities Source #

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

FieldLevelEncryptionSummary

fieldLevelEncryptionSummary_queryArgProfileConfig :: Lens' FieldLevelEncryptionSummary (Maybe QueryArgProfileConfig) Source #

A summary of a query argument-profile mapping.

fieldLevelEncryptionSummary_contentTypeProfileConfig :: Lens' FieldLevelEncryptionSummary (Maybe ContentTypeProfileConfig) Source #

A summary of a content type-profile mapping.

fieldLevelEncryptionSummary_comment :: Lens' FieldLevelEncryptionSummary (Maybe Text) Source #

An optional comment about the field-level encryption item. The comment cannot be longer than 128 characters.

fieldLevelEncryptionSummary_id :: Lens' FieldLevelEncryptionSummary Text Source #

The unique ID of a field-level encryption item.

fieldLevelEncryptionSummary_lastModifiedTime :: Lens' FieldLevelEncryptionSummary UTCTime Source #

The last time that the summary of field-level encryption items was modified.

FieldPatterns

fieldPatterns_items :: Lens' FieldPatterns (Maybe [Text]) Source #

An array of the field-level encryption field patterns.

fieldPatterns_quantity :: Lens' FieldPatterns Int Source #

The number of field-level encryption field patterns.

ForwardedValues

forwardedValues_queryStringCacheKeys :: Lens' ForwardedValues (Maybe QueryStringCacheKeys) Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

forwardedValues_headers :: Lens' ForwardedValues (Maybe Headers) Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.

For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.

forwardedValues_queryString :: Lens' ForwardedValues Bool Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

forwardedValues_cookies :: Lens' ForwardedValues CookiePreference Source #

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

FunctionAssociation

functionAssociation_functionARN :: Lens' FunctionAssociation Text Source #

The Amazon Resource Name (ARN) of the function.

functionAssociation_eventType :: Lens' FunctionAssociation EventType Source #

The event type of the function, either viewer-request or viewer-response. You cannot use origin-facing event types (origin-request and origin-response) with a CloudFront function.

FunctionAssociations

functionAssociations_items :: Lens' FunctionAssociations (Maybe [FunctionAssociation]) Source #

The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

functionAssociations_quantity :: Lens' FunctionAssociations Int Source #

The number of CloudFront functions in the list.

FunctionConfig

functionConfig_comment :: Lens' FunctionConfig Text Source #

A comment to describe the function.

functionConfig_runtime :: Lens' FunctionConfig FunctionRuntime Source #

The function’s runtime environment. The only valid value is cloudfront-js-1.0.

FunctionList

functionList_items :: Lens' FunctionList (Maybe [FunctionSummary]) Source #

Contains the functions in the list.

functionList_nextMarker :: Lens' FunctionList (Maybe Text) Source #

If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing functions where you left off.

functionList_maxItems :: Lens' FunctionList Int Source #

The maximum number of functions requested.

functionList_quantity :: Lens' FunctionList Int Source #

The number of functions returned in the response.

FunctionMetadata

functionMetadata_stage :: Lens' FunctionMetadata (Maybe FunctionStage) Source #

The stage that the function is in, either DEVELOPMENT or LIVE.

When a function is in the DEVELOPMENT stage, you can test the function with TestFunction, and update it with UpdateFunction.

When a function is in the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.

functionMetadata_createdTime :: Lens' FunctionMetadata (Maybe UTCTime) Source #

The date and time when the function was created.

functionMetadata_functionARN :: Lens' FunctionMetadata Text Source #

The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.

functionMetadata_lastModifiedTime :: Lens' FunctionMetadata UTCTime Source #

The date and time when the function was most recently updated.

FunctionSummary

functionSummary_status :: Lens' FunctionSummary (Maybe Text) Source #

The status of the CloudFront function.

functionSummary_name :: Lens' FunctionSummary Text Source #

The name of the CloudFront function.

functionSummary_functionConfig :: Lens' FunctionSummary FunctionConfig Source #

Contains configuration information about a CloudFront function.

functionSummary_functionMetadata :: Lens' FunctionSummary FunctionMetadata Source #

Contains metadata about a CloudFront function.

GeoRestriction

geoRestriction_items :: Lens' GeoRestriction (Maybe [Text]) Source #

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the /International Organization for Standardization/ website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

geoRestriction_restrictionType :: Lens' GeoRestriction GeoRestrictionType Source #

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.
  • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.
  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

geoRestriction_quantity :: Lens' GeoRestriction Int Source #

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

Headers

headers_items :: Lens' Headers (Maybe [Text]) Source #

A list of HTTP header names.

headers_quantity :: Lens' Headers Int Source #

The number of header names in the Items list.

Invalidation

invalidation_id :: Lens' Invalidation Text Source #

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

invalidation_status :: Lens' Invalidation Text Source #

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

invalidation_createTime :: Lens' Invalidation UTCTime Source #

The date and time the invalidation request was first made.

invalidation_invalidationBatch :: Lens' Invalidation InvalidationBatch Source #

The current invalidation information for the batch request.

InvalidationBatch

invalidationBatch_paths :: Lens' InvalidationBatch Paths Source #

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

invalidationBatch_callerReference :: Lens' InvalidationBatch Text Source #

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

InvalidationList

invalidationList_items :: Lens' InvalidationList (Maybe [InvalidationSummary]) Source #

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current account.

invalidationList_nextMarker :: Lens' InvalidationList (Maybe Text) Source #

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

invalidationList_marker :: Lens' InvalidationList Text Source #

The value that you provided for the Marker request parameter.

invalidationList_maxItems :: Lens' InvalidationList Int Source #

The value that you provided for the MaxItems request parameter.

invalidationList_isTruncated :: Lens' InvalidationList Bool Source #

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

invalidationList_quantity :: Lens' InvalidationList Int Source #

The number of invalidation batches that were created by the current account.

InvalidationSummary

invalidationSummary_id :: Lens' InvalidationSummary Text Source #

The unique ID for an invalidation request.

invalidationSummary_createTime :: Lens' InvalidationSummary UTCTime Source #

The time that an invalidation request was created.

invalidationSummary_status :: Lens' InvalidationSummary Text Source #

The status of an invalidation request.

KGKeyPairIds

kGKeyPairIds_keyPairIds :: Lens' KGKeyPairIds (Maybe KeyPairIds) Source #

Undocumented member.

kGKeyPairIds_keyGroupId :: Lens' KGKeyPairIds (Maybe Text) Source #

The identifier of the key group that contains the public keys.

KeyGroup

keyGroup_id :: Lens' KeyGroup Text Source #

The identifier for the key group.

keyGroup_lastModifiedTime :: Lens' KeyGroup UTCTime Source #

The date and time when the key group was last modified.

keyGroup_keyGroupConfig :: Lens' KeyGroup KeyGroupConfig Source #

The key group configuration.

KeyGroupConfig

keyGroupConfig_comment :: Lens' KeyGroupConfig (Maybe Text) Source #

A comment to describe the key group. The comment cannot be longer than 128 characters.

keyGroupConfig_name :: Lens' KeyGroupConfig Text Source #

A name to identify the key group.

keyGroupConfig_items :: Lens' KeyGroupConfig [Text] Source #

A list of the identifiers of the public keys in the key group.

KeyGroupList

keyGroupList_items :: Lens' KeyGroupList (Maybe [KeyGroupSummary]) Source #

A list of key groups.

keyGroupList_nextMarker :: Lens' KeyGroupList (Maybe Text) Source #

If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing key groups.

keyGroupList_maxItems :: Lens' KeyGroupList Int Source #

The maximum number of key groups requested.

keyGroupList_quantity :: Lens' KeyGroupList Int Source #

The number of key groups returned in the response.

KeyGroupSummary

keyGroupSummary_keyGroup :: Lens' KeyGroupSummary KeyGroup Source #

A key group.

KeyPairIds

keyPairIds_items :: Lens' KeyPairIds (Maybe [Text]) Source #

A list of CloudFront key pair identifiers.

keyPairIds_quantity :: Lens' KeyPairIds Int Source #

The number of key pair identifiers in the list.

KinesisStreamConfig

kinesisStreamConfig_roleARN :: Lens' KinesisStreamConfig Text Source #

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide.

kinesisStreamConfig_streamARN :: Lens' KinesisStreamConfig Text Source #

The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.

LambdaFunctionAssociation

lambdaFunctionAssociation_includeBody :: Lens' LambdaFunctionAssociation (Maybe Bool) Source #

A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.

lambdaFunctionAssociation_lambdaFunctionARN :: Lens' LambdaFunctionAssociation Text Source #

The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.

lambdaFunctionAssociation_eventType :: Lens' LambdaFunctionAssociation EventType Source #

Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:

  • viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.
  • origin-request: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.
  • origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.

  • viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

LambdaFunctionAssociations

lambdaFunctionAssociations_items :: Lens' LambdaFunctionAssociations (Maybe [LambdaFunctionAssociation]) Source #

Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.

lambdaFunctionAssociations_quantity :: Lens' LambdaFunctionAssociations Int Source #

The number of Lambda@Edge function associations for this cache behavior.

LoggingConfig

loggingConfig_enabled :: Lens' LoggingConfig Bool Source #

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

loggingConfig_includeCookies :: Lens' LoggingConfig Bool Source #

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

loggingConfig_bucket :: Lens' LoggingConfig Text Source #

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

loggingConfig_prefix :: Lens' LoggingConfig Text Source #

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

MonitoringSubscription

monitoringSubscription_realtimeMetricsSubscriptionConfig :: Lens' MonitoringSubscription (Maybe RealtimeMetricsSubscriptionConfig) Source #

A subscription configuration for additional CloudWatch metrics.

Origin

origin_customHeaders :: Lens' Origin (Maybe CustomHeaders) Source #

A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.

For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.

origin_customOriginConfig :: Lens' Origin (Maybe CustomOriginConfig) Source #

Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.

origin_connectionTimeout :: Lens' Origin (Maybe Int) Source #

The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don’t specify otherwise) is 10 seconds.

For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

origin_connectionAttempts :: Lens' Origin (Maybe Int) Source #

The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

For a custom origin (including an Amazon S3 bucket that’s configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

origin_s3OriginConfig :: Lens' Origin (Maybe S3OriginConfig) Source #

Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.

origin_originPath :: Lens' Origin (Maybe Text) Source #

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

For more information, see Origin Path in the Amazon CloudFront Developer Guide.

origin_originShield :: Lens' Origin (Maybe OriginShield) Source #

CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.

For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.

origin_id :: Lens' Origin Text Source #

A unique identifier for the origin. This value must be unique within the distribution.

Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.

origin_domainName :: Lens' Origin Text Source #

The domain name for the origin.

For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.

OriginCustomHeader

originCustomHeader_headerName :: Lens' OriginCustomHeader Text Source #

The name of a header that you want CloudFront to send to your origin. For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.

originCustomHeader_headerValue :: Lens' OriginCustomHeader Text Source #

The value for the header that you specified in the HeaderName field.

OriginGroup

originGroup_id :: Lens' OriginGroup Text Source #

The origin group's ID.

originGroup_failoverCriteria :: Lens' OriginGroup OriginGroupFailoverCriteria Source #

A complex type that contains information about the failover criteria for an origin group.

originGroup_members :: Lens' OriginGroup OriginGroupMembers Source #

A complex type that contains information about the origins in an origin group.

OriginGroupFailoverCriteria

originGroupFailoverCriteria_statusCodes :: Lens' OriginGroupFailoverCriteria StatusCodes Source #

The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

OriginGroupMember

originGroupMember_originId :: Lens' OriginGroupMember Text Source #

The ID for an origin in an origin group.

OriginGroupMembers

originGroupMembers_quantity :: Lens' OriginGroupMembers Int Source #

The number of origins in an origin group.

originGroupMembers_items :: Lens' OriginGroupMembers (NonEmpty OriginGroupMember) Source #

Items (origins) in an origin group.

OriginGroups

originGroups_items :: Lens' OriginGroups (Maybe [OriginGroup]) Source #

The items (origin groups) in a distribution.

originGroups_quantity :: Lens' OriginGroups Int Source #

The number of origin groups.

OriginRequestPolicy

originRequestPolicy_id :: Lens' OriginRequestPolicy Text Source #

The unique identifier for the origin request policy.

originRequestPolicy_lastModifiedTime :: Lens' OriginRequestPolicy UTCTime Source #

The date and time when the origin request policy was last modified.

originRequestPolicy_originRequestPolicyConfig :: Lens' OriginRequestPolicy OriginRequestPolicyConfig Source #

The origin request policy configuration.

OriginRequestPolicyConfig

originRequestPolicyConfig_comment :: Lens' OriginRequestPolicyConfig (Maybe Text) Source #

A comment to describe the origin request policy. The comment cannot be longer than 128 characters.

originRequestPolicyConfig_name :: Lens' OriginRequestPolicyConfig Text Source #

A unique name to identify the origin request policy.

originRequestPolicyConfig_headersConfig :: Lens' OriginRequestPolicyConfig OriginRequestPolicyHeadersConfig Source #

The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

originRequestPolicyConfig_cookiesConfig :: Lens' OriginRequestPolicyConfig OriginRequestPolicyCookiesConfig Source #

The cookies from viewer requests to include in origin requests.

originRequestPolicyConfig_queryStringsConfig :: Lens' OriginRequestPolicyConfig OriginRequestPolicyQueryStringsConfig Source #

The URL query strings from viewer requests to include in origin requests.

OriginRequestPolicyCookiesConfig

originRequestPolicyCookiesConfig_cookies :: Lens' OriginRequestPolicyCookiesConfig (Maybe CookieNames) Source #

Undocumented member.

originRequestPolicyCookiesConfig_cookieBehavior :: Lens' OriginRequestPolicyCookiesConfig OriginRequestPolicyCookieBehavior Source #

Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

  • none – Cookies in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.
  • whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.
  • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

OriginRequestPolicyHeadersConfig

originRequestPolicyHeadersConfig_headers :: Lens' OriginRequestPolicyHeadersConfig (Maybe Headers) Source #

Undocumented member.

originRequestPolicyHeadersConfig_headerBehavior :: Lens' OriginRequestPolicyHeadersConfig OriginRequestPolicyHeaderBehavior Source #

Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:

  • none – HTTP headers are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in a CachePolicy are included in origin requests.
  • whitelist – The HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.
  • allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.
  • allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.

OriginRequestPolicyList

originRequestPolicyList_items :: Lens' OriginRequestPolicyList (Maybe [OriginRequestPolicySummary]) Source #

Contains the origin request policies in the list.

originRequestPolicyList_nextMarker :: Lens' OriginRequestPolicyList (Maybe Text) Source #

If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing origin request policies where you left off.

originRequestPolicyList_maxItems :: Lens' OriginRequestPolicyList Int Source #

The maximum number of origin request policies requested.

originRequestPolicyList_quantity :: Lens' OriginRequestPolicyList Int Source #

The total number of origin request policies returned in the response.

OriginRequestPolicyQueryStringsConfig

originRequestPolicyQueryStringsConfig_queryStrings :: Lens' OriginRequestPolicyQueryStringsConfig (Maybe QueryStringNames) Source #

Contains a list of the query strings in viewer requests that are included in requests that CloudFront sends to the origin.

originRequestPolicyQueryStringsConfig_queryStringBehavior :: Lens' OriginRequestPolicyQueryStringsConfig OriginRequestPolicyQueryStringBehavior Source #

Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

  • none – Query strings in viewer requests are not included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.
  • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.
  • all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

OriginRequestPolicySummary

originRequestPolicySummary_type :: Lens' OriginRequestPolicySummary OriginRequestPolicyType Source #

The type of origin request policy, either managed (created by Amazon Web Services) or custom (created in this account).

originRequestPolicySummary_originRequestPolicy :: Lens' OriginRequestPolicySummary OriginRequestPolicy Source #

The origin request policy.

OriginShield

originShield_originShieldRegion :: Lens' OriginShield (Maybe Text) Source #

The Region for Origin Shield.

Specify the Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as us-east-2.

When you enable CloudFront Origin Shield, you must specify the Region for Origin Shield. For the list of Regions that you can specify, and for help choosing the best Region for your origin, see Choosing the Region for Origin Shield in the Amazon CloudFront Developer Guide.

originShield_enabled :: Lens' OriginShield Bool Source #

A flag that specifies whether Origin Shield is enabled.

When it’s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it’s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.

OriginSslProtocols

originSslProtocols_quantity :: Lens' OriginSslProtocols Int Source #

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

originSslProtocols_items :: Lens' OriginSslProtocols [SslProtocol] Source #

A list that contains allowed SSL/TLS protocols for this distribution.

Origins

origins_quantity :: Lens' Origins Int Source #

The number of origins for this distribution.

origins_items :: Lens' Origins (NonEmpty Origin) Source #

A list of origins.

ParametersInCacheKeyAndForwardedToOrigin

parametersInCacheKeyAndForwardedToOrigin_enableAcceptEncodingBrotli :: Lens' ParametersInCacheKeyAndForwardedToOrigin (Maybe Bool) Source #

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header
  • Includes the normalized header in the cache key
  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

parametersInCacheKeyAndForwardedToOrigin_enableAcceptEncodingGzip :: Lens' ParametersInCacheKeyAndForwardedToOrigin Bool Source #

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header
  • Includes the normalized header in the cache key
  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

parametersInCacheKeyAndForwardedToOrigin_headersConfig :: Lens' ParametersInCacheKeyAndForwardedToOrigin CachePolicyHeadersConfig Source #

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

parametersInCacheKeyAndForwardedToOrigin_cookiesConfig :: Lens' ParametersInCacheKeyAndForwardedToOrigin CachePolicyCookiesConfig Source #

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

parametersInCacheKeyAndForwardedToOrigin_queryStringsConfig :: Lens' ParametersInCacheKeyAndForwardedToOrigin CachePolicyQueryStringsConfig Source #

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Paths

paths_items :: Lens' Paths (Maybe [Text]) Source #

A complex type that contains a list of the paths that you want to invalidate.

paths_quantity :: Lens' Paths Int Source #

The number of invalidation paths specified for the objects that you want to invalidate.

PublicKey

publicKey_id :: Lens' PublicKey Text Source #

The identifier of the public key.

publicKey_createdTime :: Lens' PublicKey UTCTime Source #

The date and time when the public key was uploaded.

publicKey_publicKeyConfig :: Lens' PublicKey PublicKeyConfig Source #

Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.

PublicKeyConfig

publicKeyConfig_comment :: Lens' PublicKeyConfig (Maybe Text) Source #

A comment to describe the public key. The comment cannot be longer than 128 characters.

publicKeyConfig_callerReference :: Lens' PublicKeyConfig Text Source #

A string included in the request to help make sure that the request can’t be replayed.

publicKeyConfig_name :: Lens' PublicKeyConfig Text Source #

A name to help identify the public key.

publicKeyConfig_encodedKey :: Lens' PublicKeyConfig Text Source #

The public key that you can use with signed URLs and signed cookies, or with field-level encryption.

PublicKeyList

publicKeyList_items :: Lens' PublicKeyList (Maybe [PublicKeySummary]) Source #

A list of public keys.

publicKeyList_nextMarker :: Lens' PublicKeyList (Maybe Text) Source #

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.

publicKeyList_maxItems :: Lens' PublicKeyList Int Source #

The maximum number of public keys you want in the response.

publicKeyList_quantity :: Lens' PublicKeyList Int Source #

The number of public keys in the list.

PublicKeySummary

publicKeySummary_comment :: Lens' PublicKeySummary (Maybe Text) Source #

A comment to describe the public key. The comment cannot be longer than 128 characters.

publicKeySummary_id :: Lens' PublicKeySummary Text Source #

The identifier of the public key.

publicKeySummary_name :: Lens' PublicKeySummary Text Source #

A name to help identify the public key.

publicKeySummary_createdTime :: Lens' PublicKeySummary UTCTime Source #

The date and time when the public key was uploaded.

publicKeySummary_encodedKey :: Lens' PublicKeySummary Text Source #

The public key.

QueryArgProfile

queryArgProfile_queryArg :: Lens' QueryArgProfile Text Source #

Query argument for field-level encryption query argument-profile mapping.

queryArgProfile_profileId :: Lens' QueryArgProfile Text Source #

ID of profile to use for field-level encryption query argument-profile mapping

QueryArgProfileConfig

queryArgProfileConfig_queryArgProfiles :: Lens' QueryArgProfileConfig (Maybe QueryArgProfiles) Source #

Profiles specified for query argument-profile mapping for field-level encryption.

queryArgProfileConfig_forwardWhenQueryArgProfileIsUnknown :: Lens' QueryArgProfileConfig Bool Source #

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

QueryArgProfiles

queryArgProfiles_items :: Lens' QueryArgProfiles (Maybe [QueryArgProfile]) Source #

Number of items for query argument-profile mapping for field-level encryption.

queryArgProfiles_quantity :: Lens' QueryArgProfiles Int Source #

Number of profiles for query argument-profile mapping for field-level encryption.

QueryStringCacheKeys

queryStringCacheKeys_items :: Lens' QueryStringCacheKeys (Maybe [Text]) Source #

A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

queryStringCacheKeys_quantity :: Lens' QueryStringCacheKeys Int Source #

The number of whitelisted query string parameters for a cache behavior.

QueryStringNames

queryStringNames_items :: Lens' QueryStringNames (Maybe [Text]) Source #

A list of query string names.

queryStringNames_quantity :: Lens' QueryStringNames Int Source #

The number of query string names in the Items list.

RealtimeLogConfig

realtimeLogConfig_arn :: Lens' RealtimeLogConfig Text Source #

The Amazon Resource Name (ARN) of this real-time log configuration.

realtimeLogConfig_name :: Lens' RealtimeLogConfig Text Source #

The unique name of this real-time log configuration.

realtimeLogConfig_samplingRate :: Lens' RealtimeLogConfig Integer Source #

The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.

realtimeLogConfig_endPoints :: Lens' RealtimeLogConfig [EndPoint] Source #

Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

realtimeLogConfig_fields :: Lens' RealtimeLogConfig [Text] Source #

A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.

RealtimeLogConfigs

realtimeLogConfigs_items :: Lens' RealtimeLogConfigs (Maybe [RealtimeLogConfig]) Source #

Contains the list of real-time log configurations.

realtimeLogConfigs_nextMarker :: Lens' RealtimeLogConfigs (Maybe Text) Source #

If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing real-time log configurations where you left off.

realtimeLogConfigs_maxItems :: Lens' RealtimeLogConfigs Int Source #

The maximum number of real-time log configurations requested.

realtimeLogConfigs_isTruncated :: Lens' RealtimeLogConfigs Bool Source #

A flag that indicates whether there are more real-time log configurations than are contained in this list.

realtimeLogConfigs_marker :: Lens' RealtimeLogConfigs Text Source #

This parameter indicates where this list of real-time log configurations begins. This list includes real-time log configurations that occur after the marker.

RealtimeMetricsSubscriptionConfig

realtimeMetricsSubscriptionConfig_realtimeMetricsSubscriptionStatus :: Lens' RealtimeMetricsSubscriptionConfig RealtimeMetricsSubscriptionStatus Source #

A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

Restrictions

restrictions_geoRestriction :: Lens' Restrictions GeoRestriction Source #

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

S3Origin

s3Origin_domainName :: Lens' S3Origin Text Source #

The DNS name of the Amazon S3 origin.

s3Origin_originAccessIdentity :: Lens' S3Origin Text Source #

The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide.

S3OriginConfig

s3OriginConfig_originAccessIdentity :: Lens' S3OriginConfig Text Source #

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Signer

signer_awsAccountNumber :: Lens' Signer (Maybe Text) Source #

An account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.

signer_keyPairIds :: Lens' Signer (Maybe KeyPairIds) Source #

A list of CloudFront key pair identifiers.

StatusCodes

statusCodes_quantity :: Lens' StatusCodes Int Source #

The number of status codes.

statusCodes_items :: Lens' StatusCodes (NonEmpty Int) Source #

The items (status codes) for an origin group.

StreamingDistribution

streamingDistribution_lastModifiedTime :: Lens' StreamingDistribution (Maybe UTCTime) Source #

The date and time that the distribution was last modified.

streamingDistribution_id :: Lens' StreamingDistribution Text Source #

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

streamingDistribution_arn :: Lens' StreamingDistribution Text Source #

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your account ID.

streamingDistribution_status :: Lens' StreamingDistribution Text Source #

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

streamingDistribution_domainName :: Lens' StreamingDistribution Text Source #

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

streamingDistribution_activeTrustedSigners :: Lens' StreamingDistribution ActiveTrustedSigners Source #

A complex type that lists the accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the account number of the trusted signer or self if the signer is the account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

streamingDistribution_streamingDistributionConfig :: Lens' StreamingDistribution StreamingDistributionConfig Source #

The current configuration information for the RTMP distribution.

StreamingDistributionConfig

streamingDistributionConfig_aliases :: Lens' StreamingDistributionConfig (Maybe Aliases) Source #

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

streamingDistributionConfig_priceClass :: Lens' StreamingDistributionConfig (Maybe PriceClass) Source #

A complex type that contains information about price class for this streaming distribution.

streamingDistributionConfig_logging :: Lens' StreamingDistributionConfig (Maybe StreamingLoggingConfig) Source #

A complex type that controls whether access logs are written for the streaming distribution.

streamingDistributionConfig_callerReference :: Lens' StreamingDistributionConfig Text Source #

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

streamingDistributionConfig_s3Origin :: Lens' StreamingDistributionConfig S3Origin Source #

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

streamingDistributionConfig_comment :: Lens' StreamingDistributionConfig Text Source #

Any comments you want to include about the streaming distribution.

streamingDistributionConfig_trustedSigners :: Lens' StreamingDistributionConfig TrustedSigners Source #

A complex type that specifies any accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

streamingDistributionConfig_enabled :: Lens' StreamingDistributionConfig Bool Source #

Whether the streaming distribution is enabled to accept user requests for content.

StreamingDistributionConfigWithTags

streamingDistributionConfigWithTags_streamingDistributionConfig :: Lens' StreamingDistributionConfigWithTags StreamingDistributionConfig Source #

A streaming distribution Configuration.

streamingDistributionConfigWithTags_tags :: Lens' StreamingDistributionConfigWithTags Tags Source #

A complex type that contains zero or more Tag elements.

StreamingDistributionList

streamingDistributionList_items :: Lens' StreamingDistributionList (Maybe [StreamingDistributionSummary]) Source #

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current account.

streamingDistributionList_nextMarker :: Lens' StreamingDistributionList (Maybe Text) Source #

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

streamingDistributionList_marker :: Lens' StreamingDistributionList Text Source #

The value you provided for the Marker request parameter.

streamingDistributionList_maxItems :: Lens' StreamingDistributionList Int Source #

The value you provided for the MaxItems request parameter.

streamingDistributionList_isTruncated :: Lens' StreamingDistributionList Bool Source #

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

streamingDistributionList_quantity :: Lens' StreamingDistributionList Int Source #

The number of streaming distributions that were created by the current account.

StreamingDistributionSummary

streamingDistributionSummary_id :: Lens' StreamingDistributionSummary Text Source #

The identifier for the distribution, for example, EDFDVBD632BHDS5.

streamingDistributionSummary_arn :: Lens' StreamingDistributionSummary Text Source #

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your account ID.

streamingDistributionSummary_status :: Lens' StreamingDistributionSummary Text Source #

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

streamingDistributionSummary_lastModifiedTime :: Lens' StreamingDistributionSummary UTCTime Source #

The date and time the distribution was last modified.

streamingDistributionSummary_domainName :: Lens' StreamingDistributionSummary Text Source #

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

streamingDistributionSummary_s3Origin :: Lens' StreamingDistributionSummary S3Origin Source #

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

streamingDistributionSummary_aliases :: Lens' StreamingDistributionSummary Aliases Source #

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

streamingDistributionSummary_trustedSigners :: Lens' StreamingDistributionSummary TrustedSigners Source #

A complex type that specifies the accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

streamingDistributionSummary_comment :: Lens' StreamingDistributionSummary Text Source #

The comment originally specified when this distribution was created.

streamingDistributionSummary_priceClass :: Lens' StreamingDistributionSummary PriceClass Source #

A complex type that contains information about price class for this streaming distribution.

streamingDistributionSummary_enabled :: Lens' StreamingDistributionSummary Bool Source #

Whether the distribution is enabled to accept end user requests for content.

StreamingLoggingConfig

streamingLoggingConfig_enabled :: Lens' StreamingLoggingConfig Bool Source #

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

streamingLoggingConfig_bucket :: Lens' StreamingLoggingConfig Text Source #

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

streamingLoggingConfig_prefix :: Lens' StreamingLoggingConfig Text Source #

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

tag_key :: Lens' Tag Text Source #

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

TagKeys

tagKeys_items :: Lens' TagKeys (Maybe [Text]) Source #

A complex type that contains Tag key elements.

Tags

tags_items :: Lens' Tags (Maybe [Tag]) Source #

A complex type that contains Tag elements.

TestResult

testResult_computeUtilization :: Lens' TestResult (Maybe Text) Source #

The amount of time that the function took to run as a percentage of the maximum allowed time. For example, a compute utilization of 35 means that the function completed in 35% of the maximum allowed time.

testResult_functionExecutionLogs :: Lens' TestResult (Maybe [Text]) Source #

Contains the log lines that the function wrote (if any) when running the test.

testResult_functionOutput :: Lens' TestResult (Maybe Text) Source #

The event object returned by the function. For more information about the structure of the event object, see Event object structure in the Amazon CloudFront Developer Guide.

testResult_functionSummary :: Lens' TestResult (Maybe FunctionSummary) Source #

Contains configuration information and metadata about the CloudFront function that was tested.

testResult_functionErrorMessage :: Lens' TestResult (Maybe Text) Source #

If the result of testing the function was an error, this field contains the error message.

TrustedKeyGroups

trustedKeyGroups_items :: Lens' TrustedKeyGroups (Maybe [Text]) Source #

A list of key groups identifiers.

trustedKeyGroups_enabled :: Lens' TrustedKeyGroups Bool Source #

This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

trustedKeyGroups_quantity :: Lens' TrustedKeyGroups Int Source #

The number of key groups in the list.

TrustedSigners

trustedSigners_items :: Lens' TrustedSigners (Maybe [Text]) Source #

A list of account identifiers.

trustedSigners_enabled :: Lens' TrustedSigners Bool Source #

This field is true if any of the accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.

trustedSigners_quantity :: Lens' TrustedSigners Int Source #

The number of accounts in the list.

ViewerCertificate

viewerCertificate_sSLSupportMethod :: Lens' ViewerCertificate (Maybe SSLSupportMethod) Source #

If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.

  • sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.
  • vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.
  • static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.

viewerCertificate_aCMCertificateArn :: Lens' ViewerCertificate (Maybe Text) Source #

If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1).

If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.

viewerCertificate_certificateSource :: Lens' ViewerCertificate (Maybe CertificateSource) Source #

This field is deprecated. Use one of the following fields instead:

  • ACMCertificateArn
  • IAMCertificateId
  • CloudFrontDefaultCertificate

viewerCertificate_minimumProtocolVersion :: Lens' ViewerCertificate (Maybe MinimumProtocolVersion) Source #

If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:

  • The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
  • The ciphers that CloudFront can use to encrypt the content that it returns to viewers.

For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

On the CloudFront console, this setting is called Security Policy.

When you’re using SNI only (you set SSLSupportMethod to sni-only), you must specify TLSv1 or higher.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.

viewerCertificate_certificate :: Lens' ViewerCertificate (Maybe Text) Source #

This field is deprecated. Use one of the following fields instead:

  • ACMCertificateArn
  • IAMCertificateId
  • CloudFrontDefaultCertificate

viewerCertificate_iAMCertificateId :: Lens' ViewerCertificate (Maybe Text) Source #

If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.

If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.

viewerCertificate_cloudFrontDefaultCertificate :: Lens' ViewerCertificate (Maybe Bool) Source #

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true.

If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:

  • ACMCertificateArn or IAMCertificateId (specify a value for one, not both)
  • MinimumProtocolVersion
  • SSLSupportMethod