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.

createCloudFrontOriginAccessIdentity2017_10_30({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.

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

Creates a new web distribution. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

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

Create a new distribution with tags.

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

Create a new field-level encryption configuration.

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

Create a field-level encryption profile.

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

Create a new invalidation.

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

Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.

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

Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

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

Create a new streaming distribution with tags.

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

Delete an origin access identity.

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

Delete a distribution.

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

Remove a field-level encryption configuration.

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

Remove a field-level encryption profile.

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

Remove a public key you previously added to CloudFront.

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

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

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

Get the information about an origin access identity.

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

Get the configuration information about an origin access identity.

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

Get the information about a distribution.

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

Get the configuration information about a distribution.

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

Get the field-level encryption configuration information.

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

Get the field-level encryption configuration information.

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

Get the field-level encryption profile information.

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

Get the field-level encryption profile configuration information.

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

Get the information about an invalidation.

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

Get the public key information.

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

Return public key configuration informaation

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

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

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

Get the configuration information about a streaming distribution.

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

Lists origin access identities.

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

List distributions.

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

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

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

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

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

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

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

Lists invalidation batches.

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

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

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

List streaming distributions.

listTagsForResource2017_10_30({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

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

Add tags to a CloudFront resource.

toString() → String

A string representation of this object.

inherited

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

Remove tags from a CloudFront resource.

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

Update an origin access identity.

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

Updates the configuration for a web distribution. Perform the following steps.

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

Update a field-level encryption configuration.

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

Update a field-level encryption profile.

updatePublicKey2017_10_30({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.

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

Update a streaming distribution.

Operators

operator ==(Object other) → bool

The equality operator.

inherited