AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Generate a policy document that describes custom access permissions to apply via a private distribution's signed URL.

Namespace: Amazon.CloudFront
Assembly: AWSSDK.CloudFront.dll
Version: 3.x.y.z

Syntax

C#
public String BuildPolicyForSignedUrl(
         String resourcePath,
         DateTime expiresOn,
         String limitToIpAddressCIDR,
         DateTime activeFrom
)
Parameters
resourcePath
Type: System.String

An optional HTTP/S or RTMP resource path that restricts which distribution and S3 objects will be accessible in a signed URL. For standard distributions the resource URL will be "http://" + distributionName + "/" + path (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with "https://". RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. The '*' and '?' characters can be used as a wildcards to allow multi-character or single-character matches respectively: * : All distributions/objects will be accessible a1b2c3d4e5f6g7.cloudfront.net/* : All objects within the distribution a1b2c3d4e5f6g7 will be accessible a1b2c3d4e5f6g7.cloudfront.net/path/to/object.txt : Only the S3 object named path/to/object.txt in the distribution a1b2c3d4e5f6g7 will be accessible. If this parameter is null the policy will permit access to all distributions and S3 objects associated with the certificate keypair used to generate the signed URL.

expiresOn
Type: System.DateTime

The time and date when the signed URL will expire.

limitToIpAddressCIDR
Type: System.String

An optional range of client IP addresses that will be allowed to access the distribution, specified as a CIDR range. If null, the CIDR will be 0.0.0.0/0 and any client will be permitted.

activeFrom
Type: System.DateTime

An optional UTC time and date when the signed URL will become active. A value of DateTime.MinValue (the default value of DateTime) is ignored.

Return Value
Type: String
A policy document describing the access permission to apply when generating a signed URL.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5