Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateDistribution

Creates an Amazon Lightsail content delivery network (CDN) distribution.

A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.

Request Syntax


{
   "bundleId": "string",
   "cacheBehaviors": [ 
      { 
         "behavior": "string",
         "path": "string"
      }
   ],
   "cacheBehaviorSettings": { 
      "allowedHTTPMethods": "string",
      "cachedHTTPMethods": "string",
      "defaultTTL": number,
      "forwardedCookies": { 
         "cookiesAllowList": [ "string" ],
         "option": "string"
      },
      "forwardedHeaders": { 
         "headersAllowList": [ "string" ],
         "option": "string"
      },
      "forwardedQueryStrings": { 
         "option": boolean,
         "queryStringsAllowList": [ "string" ]
      },
      "maximumTTL": number,
      "minimumTTL": number
   },
   "certificateName": "string",
   "customErrorResponses": [ 
      { 
         "errorCachingMinTTL": number,
         "errorCode": number,
         "responseCode": "string",
         "responsePagePath": "string"
      }
   ],
   "defaultCacheBehavior": { 
      "behavior": "string"
   },
   "defaultRootObject": "string",
   "distributionName": "string",
   "enablePrivateOriginAccess": boolean,
   "ipAddressType": "string",
   "origin": { 
      "ipAddressType": "string",
      "name": "string",
      "protocolPolicy": "string",
      "regionName": "string",
      "responseTimeout": number
   },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "viewerMinimumTlsProtocolVersion": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

bundleId

The bundle ID to use for the distribution.

A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.

Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

Type: String

Required: Yes

cacheBehaviors

An array of objects that describe the per-path cache behavior for the distribution.

Type: Array of CacheBehaviorPerPath objects

Required: No

cacheBehaviorSettings

An object that describes the cache behavior settings for the distribution.

Type: CacheSettings object

Required: No

certificateName

The name of the SSL/TLS certificate that you want to attach to the distribution.

Use the GetCertificates action to get a list of certificate names that you can specify.

Type: String

Pattern: \w[\w\-]*\w

Required: No

customErrorResponses

An array of objects that describe the custom error responses for the distribution. With a custom error response, you can specify the page to return when the origin responds with a given HTTP error code. You can also specify the HTTP status code to send to the viewer.

Type: Array of DistributionCustomErrorResponse objects

Required: No

defaultCacheBehavior

An object that describes the default cache behavior for the distribution.

Type: CacheBehavior object

Required: Yes

defaultRootObject

The object (for example, index.html) that the distribution returns when a viewer requests the root URL of the distribution (/) instead of a specific object. The object that you specify must be available from the origin.

Type: String

Required: No

distributionName

The name for the distribution.

Type: String

Pattern: \w[\w\-]*\w

Required: Yes

enablePrivateOriginAccess

Specifies whether to enable private origin access for the distribution. With private origin access, the distribution can serve objects that aren't publicly accessible from a Lightsail bucket.

Lightsail grants the distribution permission to read the bucket's objects. Enabling private origin access doesn't change the bucket's access settings, and you can still retrieve publicly accessible objects directly from the bucket's endpoint.

Note

You can enable private origin access only when the distribution's origin is a Lightsail bucket. If the origin is another resource type, the request fails.

Type: Boolean

Required: No

ipAddressType

The IP address type for the distribution.

The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

Type: String

Valid Values: dualstack | ipv4 | ipv6

Required: No

origin

An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

Type: InputOrigin object

Required: Yes

tags

The tag keys and optional values to add to the distribution during create.

Use the TagResource action to tag a resource after it's created.

Type: Array of Tag objects

Required: No

viewerMinimumTlsProtocolVersion

The minimum TLS protocol version for the SSL/TLS certificate.

Type: String

Valid Values: TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021

Required: No

Response Syntax


{
   "distribution": { 
      "ableToUpdateBundle": boolean,
      "alternativeDomainNames": [ "string" ],
      "arn": "string",
      "bundleId": "string",
      "cacheBehaviors": [ 
         { 
            "behavior": "string",
            "path": "string"
         }
      ],
      "cacheBehaviorSettings": { 
         "allowedHTTPMethods": "string",
         "cachedHTTPMethods": "string",
         "defaultTTL": number,
         "forwardedCookies": { 
            "cookiesAllowList": [ "string" ],
            "option": "string"
         },
         "forwardedHeaders": { 
            "headersAllowList": [ "string" ],
            "option": "string"
         },
         "forwardedQueryStrings": { 
            "option": boolean,
            "queryStringsAllowList": [ "string" ]
         },
         "maximumTTL": number,
         "minimumTTL": number
      },
      "certificateName": "string",
      "createdAt": number,
      "customErrorResponses": [ 
         { 
            "errorCachingMinTTL": number,
            "errorCode": number,
            "responseCode": "string",
            "responsePagePath": "string"
         }
      ],
      "defaultCacheBehavior": { 
         "behavior": "string"
      },
      "defaultRootObject": "string",
      "domainName": "string",
      "ipAddressType": "string",
      "isEnabled": boolean,
      "location": { 
         "availabilityZone": "string",
         "regionName": "string"
      },
      "name": "string",
      "origin": { 
         "ipAddressType": "string",
         "isPrivateOriginAccessEnabled": boolean,
         "name": "string",
         "protocolPolicy": "string",
         "regionName": "string",
         "resourceType": "string",
         "responseTimeout": number
      },
      "originPublicDNS": "string",
      "resourceType": "string",
      "status": "string",
      "supportCode": "string",
      "tags": [ 
         { 
            "key": "string",
            "value": "string"
         }
      ],
      "viewerMinimumTlsProtocolVersion": "string"
   },
   "operation": { 
      "createdAt": number,
      "errorCode": "string",
      "errorDetails": "string",
      "id": "string",
      "isTerminal": boolean,
      "location": { 
         "availabilityZone": "string",
         "regionName": "string"
      },
      "operationDetails": "string",
      "operationType": "string",
      "resourceName": "string",
      "resourceType": "string",
      "status": "string",
      "statusChangedAt": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

distribution

An object that describes the distribution created.

Type: LightsailDistribution object

operation

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

Type: Operation object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400