Lightsail / Client / update_distribution

update_distribution#

Lightsail.Client.update_distribution(**kwargs)#

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

Use this action to update the configuration of your existing distribution.

Request Syntax

response = client.update_distribution(
    distributionName='string',
    origin={
        'name': 'string',
        'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1',
        'protocolPolicy': 'http-only'|'https-only',
        'responseTimeout': 123
    },
    defaultCacheBehavior={
        'behavior': 'dont-cache'|'cache'
    },
    cacheBehaviorSettings={
        'defaultTTL': 123,
        'minimumTTL': 123,
        'maximumTTL': 123,
        'allowedHTTPMethods': 'string',
        'cachedHTTPMethods': 'string',
        'forwardedCookies': {
            'option': 'none'|'allow-list'|'all',
            'cookiesAllowList': [
                'string',
            ]
        },
        'forwardedHeaders': {
            'option': 'none'|'allow-list'|'all',
            'headersAllowList': [
                'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
            ]
        },
        'forwardedQueryStrings': {
            'option': True|False,
            'queryStringsAllowList': [
                'string',
            ]
        }
    },
    cacheBehaviors=[
        {
            'path': 'string',
            'behavior': 'dont-cache'|'cache'
        },
    ],
    isEnabled=True|False,
    viewerMinimumTlsProtocolVersion='TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
    certificateName='string',
    useDefaultCertificate=True|False
)

Parameters:

distributionName (string) –
[REQUIRED]

The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names that you can specify.
origin (dict) –
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.
- name (string) –
  
  The name of the origin resource.
- regionName (string) –
  
  The AWS Region name of the origin resource.
- protocolPolicy (string) –
  
  The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
- responseTimeout (integer) –
  
  The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.
defaultCacheBehavior (dict) –
An object that describes the default cache behavior for the distribution.
- behavior (string) –
  
  The cache behavior of the distribution.
  
  The following cache behaviors can be specified:
  - cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn’t change depending on who views it, or for websites that don’t use cookies, headers, or query strings to personalize content.
  - dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution’s CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
cacheBehaviorSettings (dict) –
An object that describes the cache behavior settings for the distribution.

Note
The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution’s existing settings.
- defaultTTL (integer) –
  
  The default amount of time that objects stay in the distribution’s cache before the distribution forwards another request to the origin to determine whether the content has been updated.
  
  Note
  The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
- minimumTTL (integer) –
  
  The minimum amount of time that objects stay in the distribution’s cache before the distribution forwards another request to the origin to determine whether the object has been updated.
  
  A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
- maximumTTL (integer) –
  
  The maximum amount of time that objects stay in the distribution’s cache before the distribution forwards another request to the origin to determine whether the object has been updated.
  
  The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
- allowedHTTPMethods (string) –
  
  The HTTP methods that are processed and forwarded to the distribution’s origin.
  
  You can specify the following options:
  - GET,HEAD - The distribution forwards the GET and HEAD methods.
  - GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.
  - GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.
  If you specify the third option, you might need to restrict access to your distribution’s origin so users can’t perform operations that you don’t want them to. For example, you might not want users to have permission to delete objects from your origin.
- cachedHTTPMethods (string) –
  
  The HTTP method responses that are cached by your distribution.
  
  You can specify the following options:
  - GET,HEAD - The distribution caches responses to the GET and HEAD methods.
  - GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.
- forwardedCookies (dict) –
  
  An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
  - option (string) –
    
    Specifies which cookies to forward to the distribution’s origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
  - cookiesAllowList (list) –
    
    The specific cookies to forward to your distribution’s origin.
    - (string) –
- forwardedHeaders (dict) –
  
  An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
  - option (string) –
    
    The headers that you want your distribution to forward to your origin and base caching on.
    
    You can configure your distribution to do one of the following:
    - all - Forward all headers to your origin.
    - none - Forward only the default headers.
    - allow-list - Forward only the headers you specify using the headersAllowList parameter.
  - headersAllowList (list) –
    
    The specific headers to forward to your distribution’s origin.
    - (string) –
- forwardedQueryStrings (dict) –
  
  An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
  - option (boolean) –
    
    Indicates whether the distribution forwards and caches based on query strings.
  - queryStringsAllowList (list) –
    
    The specific query strings that the distribution forwards to the origin.
    
    Your distribution will cache content based on the specified query strings.
    
    If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
    - (string) –
cacheBehaviors (list) –
An array of objects that describe the per-path cache behavior for the distribution.
- (dict) –
  
  Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
  
  A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution’s cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.
  - path (string) –
    
    The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types ( *.html, *jpg, *js). Directories and file paths are case-sensitive.
    
    Examples:
    - Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
    - Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
    - Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html
    - Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
  - behavior (string) –
    
    The cache behavior for the specified path.
    
    You can specify one of the following per-path cache behaviors:
    - cache - This behavior caches the specified path.
    - dont-cache - This behavior doesn’t cache the specified path.
isEnabled (boolean) – Indicates whether to enable the distribution.
viewerMinimumTlsProtocolVersion (string) – Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that’s attached to the distribution.
certificateName (string) –
The name of the SSL/TLS certificate that you want to attach to the distribution.

Only certificates with a status of ISSUED can be attached to a distribution.

Use the GetCertificates action to get a list of certificate names that you can specify.
useDefaultCertificate (boolean) –
Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is true. When true, the distribution uses the default domain name such as d111111abcdef8.cloudfront.net.

Set this value to false to attach a new certificate to the distribution.

Return type:

dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession'|'SetupInstanceHttps',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

(dict) –
- operation (dict) –
  
  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.
  - id (string) –
    
    The ID of the operation.
  - resourceName (string) –
    
    The resource name.
  - resourceType (string) –
    
    The resource type.
  - createdAt (datetime) –
    
    The timestamp when the operation was initialized ( 1479816991.349).
  - location (dict) –
    
    The Amazon Web Services Region and Availability Zone.
    - availabilityZone (string) –
      
      The Availability Zone. Follows the format us-east-2a (case-sensitive).
    - regionName (string) –
      
      The Amazon Web Services Region name.
  - isTerminal (boolean) –
    
    A Boolean value indicating whether the operation is terminal.
  - operationDetails (string) –
    
    Details about the operation ( Debian-1GB-Ohio-1).
  - operationType (string) –
    
    The type of operation.
  - status (string) –
    
    The status of the operation.
  - statusChangedAt (datetime) –
    
    The timestamp when the status was changed ( 1479816991.349).
  - errorCode (string) –
    
    The error code.
  - errorDetails (string) –
    
    The error details.

Exceptions

Lightsail.Client.exceptions.ServiceException
Lightsail.Client.exceptions.InvalidInputException
Lightsail.Client.exceptions.NotFoundException
Lightsail.Client.exceptions.OperationFailureException
Lightsail.Client.exceptions.AccessDeniedException
Lightsail.Client.exceptions.UnauthenticatedException