CloudFront class

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

Constructors

CloudFront({String? region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createCachePolicy2020_05_31({required CachePolicyConfig cachePolicyConfig}) → Future<CreateCachePolicyResult>

Creates a cache policy.

createCloudFrontOriginAccessIdentity2020_05_31({required CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig}) → Future<CreateCloudFrontOriginAccessIdentityResult>

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

createDistribution2020_05_31({required DistributionConfig distributionConfig}) → Future<CreateDistributionResult>

Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

createDistributionWithTags2020_05_31({required DistributionConfigWithTags distributionConfigWithTags}) → Future<CreateDistributionWithTagsResult>

Create a new distribution with tags.

createFieldLevelEncryptionConfig2020_05_31({required FieldLevelEncryptionConfig fieldLevelEncryptionConfig}) → Future<CreateFieldLevelEncryptionConfigResult>

Create a new field-level encryption configuration.

createFieldLevelEncryptionProfile2020_05_31({required FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig}) → Future<CreateFieldLevelEncryptionProfileResult>

Create a field-level encryption profile.

createInvalidation2020_05_31({required String distributionId, required InvalidationBatch invalidationBatch}) → Future<CreateInvalidationResult>

Create a new invalidation.

createKeyGroup2020_05_31({required KeyGroupConfig keyGroupConfig}) → Future<CreateKeyGroupResult>

Creates a key group that you can use with CloudFront signed URLs and signed cookies.

createMonitoringSubscription2020_05_31({required String distributionId, required MonitoringSubscription monitoringSubscription}) → Future<CreateMonitoringSubscriptionResult>

Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.

createOriginRequestPolicy2020_05_31({required OriginRequestPolicyConfig originRequestPolicyConfig}) → Future<CreateOriginRequestPolicyResult>

Creates an origin request policy.

createPublicKey2020_05_31({required PublicKeyConfig publicKeyConfig}) → Future<CreatePublicKeyResult>

Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.

createRealtimeLogConfig2020_05_31({required List<EndPoint> endPoints, required List<String> fields, required String name, required int samplingRate}) → Future<CreateRealtimeLogConfigResult>

Creates a real-time log configuration.

createStreamingDistribution2020_05_31({required StreamingDistributionConfig streamingDistributionConfig}) → Future<CreateStreamingDistributionResult>

This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.

createStreamingDistributionWithTags2020_05_31({required StreamingDistributionConfigWithTags streamingDistributionConfigWithTags}) → Future<CreateStreamingDistributionWithTagsResult>

This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.

deleteCachePolicy2020_05_31({required String id, String? ifMatch}) → Future<void>

Deletes a cache policy.

deleteCloudFrontOriginAccessIdentity2020_05_31({required String id, String? ifMatch}) → Future<void>

Delete an origin access identity.

deleteDistribution2020_05_31({required String id, String? ifMatch}) → Future<void>

Delete a distribution.

deleteFieldLevelEncryptionConfig2020_05_31({required String id, String? ifMatch}) → Future<void>

Remove a field-level encryption configuration.

deleteFieldLevelEncryptionProfile2020_05_31({required String id, String? ifMatch}) → Future<void>

Remove a field-level encryption profile.

deleteKeyGroup2020_05_31({required String id, String? ifMatch}) → Future<void>

Deletes a key group.

deleteMonitoringSubscription2020_05_31({required String distributionId}) → Future<void>

Disables additional CloudWatch metrics for the specified CloudFront distribution.

deleteOriginRequestPolicy2020_05_31({required String id, String? ifMatch}) → Future<void>

Deletes an origin request policy.

deletePublicKey2020_05_31({required String id, String? ifMatch}) → Future<void>

Remove a public key you previously added to CloudFront.

deleteRealtimeLogConfig2020_05_31({String? arn, String? name}) → Future<void>

Deletes a real-time log configuration.

deleteStreamingDistribution2020_05_31({required String id, String? ifMatch}) → Future<void>

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

getCachePolicy2020_05_31({required String id}) → Future<GetCachePolicyResult>

Gets a cache policy, including the following metadata:

getCachePolicyConfig2020_05_31({required String id}) → Future<GetCachePolicyConfigResult>

Gets a cache policy configuration.

getCloudFrontOriginAccessIdentity2020_05_31({required String id}) → Future<GetCloudFrontOriginAccessIdentityResult>

Get the information about an origin access identity.

getCloudFrontOriginAccessIdentityConfig2020_05_31({required String id}) → Future<GetCloudFrontOriginAccessIdentityConfigResult>

Get the configuration information about an origin access identity.

getDistribution2020_05_31({required String id}) → Future<GetDistributionResult>

Get the information about a distribution.

getDistributionConfig2020_05_31({required String id}) → Future<GetDistributionConfigResult>

Get the configuration information about a distribution.

getFieldLevelEncryption2020_05_31({required String id}) → Future<GetFieldLevelEncryptionResult>

Get the field-level encryption configuration information.

getFieldLevelEncryptionConfig2020_05_31({required String id}) → Future<GetFieldLevelEncryptionConfigResult>

Get the field-level encryption configuration information.

getFieldLevelEncryptionProfile2020_05_31({required String id}) → Future<GetFieldLevelEncryptionProfileResult>

Get the field-level encryption profile information.

getFieldLevelEncryptionProfileConfig2020_05_31({required String id}) → Future<GetFieldLevelEncryptionProfileConfigResult>

Get the field-level encryption profile configuration information.

getInvalidation2020_05_31({required String distributionId, required String id}) → Future<GetInvalidationResult>

Get the information about an invalidation.

getKeyGroup2020_05_31({required String id}) → Future<GetKeyGroupResult>

Gets a key group, including the date and time when the key group was last modified.

getKeyGroupConfig2020_05_31({required String id}) → Future<GetKeyGroupConfigResult>

Gets a key group configuration.

getMonitoringSubscription2020_05_31({required String distributionId}) → Future<GetMonitoringSubscriptionResult>

Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.

getOriginRequestPolicy2020_05_31({required String id}) → Future<GetOriginRequestPolicyResult>

Gets an origin request policy, including the following metadata:

getOriginRequestPolicyConfig2020_05_31({required String id}) → Future<GetOriginRequestPolicyConfigResult>

Gets an origin request policy configuration.

getPublicKey2020_05_31({required String id}) → Future<GetPublicKeyResult>

Gets a public key.

getPublicKeyConfig2020_05_31({required String id}) → Future<GetPublicKeyConfigResult>

Gets a public key configuration.

getRealtimeLogConfig2020_05_31({String? arn, String? name}) → Future<GetRealtimeLogConfigResult>

Gets a real-time log configuration.

getStreamingDistribution2020_05_31({required String id}) → Future<GetStreamingDistributionResult>

Gets information about a specified RTMP distribution, including the distribution configuration.

getStreamingDistributionConfig2020_05_31({required String id}) → Future<GetStreamingDistributionConfigResult>

Get the configuration information about a streaming distribution.

listCachePolicies2020_05_31({String? marker, String? maxItems, CachePolicyType? type}) → Future<ListCachePoliciesResult>

Gets a list of cache policies.

listCloudFrontOriginAccessIdentities2020_05_31({String? marker, String? maxItems}) → Future<ListCloudFrontOriginAccessIdentitiesResult>

Lists origin access identities.

listDistributions2020_05_31({String? marker, String? maxItems}) → Future<ListDistributionsResult>

List CloudFront distributions.

listDistributionsByCachePolicyId2020_05_31({required String cachePolicyId, String? marker, String? maxItems}) → Future<ListDistributionsByCachePolicyIdResult>

Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.

listDistributionsByKeyGroup2020_05_31({required String keyGroupId, String? marker, String? maxItems}) → Future<ListDistributionsByKeyGroupResult>

Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.

listDistributionsByOriginRequestPolicyId2020_05_31({required String originRequestPolicyId, String? marker, String? maxItems}) → Future<ListDistributionsByOriginRequestPolicyIdResult>

Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.

listDistributionsByRealtimeLogConfig2020_05_31({String? marker, String? maxItems, String? realtimeLogConfigArn, String? realtimeLogConfigName}) → Future<ListDistributionsByRealtimeLogConfigResult>

Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.

listDistributionsByWebACLId2020_05_31({required String webACLId, String? marker, String? maxItems}) → Future<ListDistributionsByWebACLIdResult>

List the distributions that are associated with a specified AWS WAF web ACL.

listFieldLevelEncryptionConfigs2020_05_31({String? marker, String? maxItems}) → Future<ListFieldLevelEncryptionConfigsResult>

List all field-level encryption configurations that have been created in CloudFront for this account.

listFieldLevelEncryptionProfiles2020_05_31({String? marker, String? maxItems}) → Future<ListFieldLevelEncryptionProfilesResult>

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

listInvalidations2020_05_31({required String distributionId, String? marker, String? maxItems}) → Future<ListInvalidationsResult>

Lists invalidation batches.

listKeyGroups2020_05_31({String? marker, String? maxItems}) → Future<ListKeyGroupsResult>

Gets a list of key groups.

listOriginRequestPolicies2020_05_31({String? marker, String? maxItems, OriginRequestPolicyType? type}) → Future<ListOriginRequestPoliciesResult>

Gets a list of origin request policies.

listPublicKeys2020_05_31({String? marker, String? maxItems}) → Future<ListPublicKeysResult>

List all public keys that have been added to CloudFront for this account.

listRealtimeLogConfigs2020_05_31({String? marker, String? maxItems}) → Future<ListRealtimeLogConfigsResult>

Gets a list of real-time log configurations.

listStreamingDistributions2020_05_31({String? marker, String? maxItems}) → Future<ListStreamingDistributionsResult>

List streaming distributions.

listTagsForResource2020_05_31({required String resource}) → Future<ListTagsForResourceResult>

List tags for a CloudFront resource.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

tagResource2020_05_31({required String resource, required Tags tags}) → Future<void>

Add tags to a CloudFront resource.

toString() → String

A string representation of this object.

inherited

untagResource2020_05_31({required String resource, required TagKeys tagKeys}) → Future<void>

Remove tags from a CloudFront resource.

updateCachePolicy2020_05_31({required CachePolicyConfig cachePolicyConfig, required String id, String? ifMatch}) → Future<UpdateCachePolicyResult>

Updates a cache policy configuration.

updateCloudFrontOriginAccessIdentity2020_05_31({required CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig, required String id, String? ifMatch}) → Future<UpdateCloudFrontOriginAccessIdentityResult>

Update an origin access identity.

updateDistribution2020_05_31({required DistributionConfig distributionConfig, required String id, String? ifMatch}) → Future<UpdateDistributionResult>

Updates the configuration for a web distribution. The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.

updateFieldLevelEncryptionConfig2020_05_31({required FieldLevelEncryptionConfig fieldLevelEncryptionConfig, required String id, String? ifMatch}) → Future<UpdateFieldLevelEncryptionConfigResult>

Update a field-level encryption configuration.

updateFieldLevelEncryptionProfile2020_05_31({required FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig, required String id, String? ifMatch}) → Future<UpdateFieldLevelEncryptionProfileResult>

Update a field-level encryption profile.

updateKeyGroup2020_05_31({required String id, required KeyGroupConfig keyGroupConfig, String? ifMatch}) → Future<UpdateKeyGroupResult>

Updates a key group.

updateOriginRequestPolicy2020_05_31({required String id, required OriginRequestPolicyConfig originRequestPolicyConfig, String? ifMatch}) → Future<UpdateOriginRequestPolicyResult>

Updates an origin request policy configuration.

updatePublicKey2020_05_31({required String id, required PublicKeyConfig publicKeyConfig, String? ifMatch}) → Future<UpdatePublicKeyResult>

Update public key information. Note that the only value you can change is the comment.

updateRealtimeLogConfig2020_05_31({String? arn, List<EndPoint>? endPoints, List<String>? fields, String? name, int? samplingRate}) → Future<UpdateRealtimeLogConfigResult>

Updates a real-time log configuration.

updateStreamingDistribution2020_05_31({required String id, required StreamingDistributionConfig streamingDistributionConfig, String? ifMatch}) → Future<UpdateStreamingDistributionResult>

Update a streaming distribution.

Operators

operator ==(Object other) → bool

The equality operator.

inherited