libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.CreateDistribution

Description

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.

Synopsis

Creating a Request

data CreateDistribution Source #

See: newCreateDistribution smart constructor.

Constructors

CreateDistribution' 

Fields

  • cacheBehaviorSettings :: Maybe CacheSettings

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

  • ipAddressType :: Maybe 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.

  • cacheBehaviors :: Maybe [CacheBehaviorPerPath]

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

  • tags :: Maybe [Tag]

    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.

  • distributionName :: Text

    The name for the distribution.

  • origin :: InputOrigin

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

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

  • defaultCacheBehavior :: CacheBehavior

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

  • bundleId :: Text

    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.

Instances

Instances details
Eq CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

(==) :: CreateDistribution -> CreateDistribution -> Bool #

(/=) :: CreateDistribution -> CreateDistribution -> Bool #

Read CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

readsPrec :: Int -> ReadS CreateDistribution #

readList :: ReadS [CreateDistribution] #

readPrec :: ReadPrec CreateDistribution #

readListPrec :: ReadPrec [CreateDistribution] #

Show CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

showsPrec :: Int -> CreateDistribution -> ShowS #

show :: CreateDistribution -> String #

showList :: [CreateDistribution] -> ShowS #

Generic CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Associated Types

type Rep CreateDistribution :: Type -> Type #

Methods

from :: CreateDistribution -> Rep CreateDistribution x #

to :: Rep CreateDistribution x -> CreateDistribution #

NFData CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

rnf :: CreateDistribution -> () #

Hashable CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

hashWithSalt :: Int -> CreateDistribution -> Int #

hash :: CreateDistribution -> Int #

ToJSON CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

toJSON :: CreateDistribution -> Value #

toEncoding :: CreateDistribution -> Encoding #

toJSONList :: [CreateDistribution] -> Value #

toEncodingList :: [CreateDistribution] -> Encoding #

AWSRequest CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Associated Types

type AWSResponse CreateDistribution #

Methods

request :: CreateDistribution -> Request CreateDistribution #

response :: MonadResource m => Logger -> Service -> Proxy CreateDistribution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDistribution))) #

ToHeaders CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

toHeaders :: CreateDistribution -> [Header] #

ToPath CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

toPath :: CreateDistribution -> ByteString #

ToQuery CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

toQuery :: CreateDistribution -> QueryString #

type Rep CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

type Rep CreateDistribution = D1 ('MetaData "CreateDistribution" "Amazonka.Lightsail.CreateDistribution" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "CreateDistribution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheBehaviorSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheSettings)) :*: S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType))) :*: (S1 ('MetaSel ('Just "cacheBehaviors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CacheBehaviorPerPath])) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "distributionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "origin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputOrigin)) :*: (S1 ('MetaSel ('Just "defaultCacheBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CacheBehavior) :*: S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

type AWSResponse CreateDistribution = CreateDistributionResponse

newCreateDistribution Source #

Arguments

:: Text

$sel:distributionName:CreateDistribution'

-> InputOrigin

$sel:origin:CreateDistribution'

-> CacheBehavior

$sel:defaultCacheBehavior:CreateDistribution'

-> Text

$sel:bundleId:CreateDistribution'

-> CreateDistribution 

Create a value of CreateDistribution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheBehaviorSettings:CreateDistribution', createDistribution_cacheBehaviorSettings - An object that describes the cache behavior settings for the distribution.

$sel:ipAddressType:CreateDistribution', createDistribution_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.

$sel:cacheBehaviors:CreateDistribution', createDistribution_cacheBehaviors - An array of objects that describe the per-path cache behavior for the distribution.

$sel:tags:CreateDistribution', createDistribution_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.

$sel:distributionName:CreateDistribution', createDistribution_distributionName - The name for the distribution.

$sel:origin:CreateDistribution', createDistribution_origin - An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.

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

$sel:defaultCacheBehavior:CreateDistribution', createDistribution_defaultCacheBehavior - An object that describes the default cache behavior for the distribution.

$sel:bundleId:CreateDistribution', createDistribution_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.

Request Lenses

createDistribution_cacheBehaviorSettings :: Lens' CreateDistribution (Maybe CacheSettings) Source #

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

createDistribution_ipAddressType :: Lens' CreateDistribution (Maybe IpAddressType) Source #

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.

createDistribution_cacheBehaviors :: Lens' CreateDistribution (Maybe [CacheBehaviorPerPath]) Source #

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

createDistribution_tags :: Lens' CreateDistribution (Maybe [Tag]) Source #

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.

createDistribution_distributionName :: Lens' CreateDistribution Text Source #

The name for the distribution.

createDistribution_origin :: Lens' CreateDistribution InputOrigin Source #

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

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

createDistribution_defaultCacheBehavior :: Lens' CreateDistribution CacheBehavior Source #

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

createDistribution_bundleId :: Lens' CreateDistribution Text Source #

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.

Destructuring the Response

data CreateDistributionResponse Source #

See: newCreateDistributionResponse smart constructor.

Constructors

CreateDistributionResponse' 

Fields

Instances

Instances details
Eq CreateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

(==) :: CreateDistributionResponse -> CreateDistributionResponse -> Bool #

(/=) :: CreateDistributionResponse -> CreateDistributionResponse -> Bool #

Read CreateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

readsPrec :: Int -> ReadS CreateDistributionResponse #

readList :: ReadS [CreateDistributionResponse] #

readPrec :: ReadPrec CreateDistributionResponse #

readListPrec :: ReadPrec [CreateDistributionResponse] #

Show CreateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

showsPrec :: Int -> CreateDistributionResponse -> ShowS #

show :: CreateDistributionResponse -> String #

showList :: [CreateDistributionResponse] -> ShowS #

Generic CreateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Associated Types

type Rep CreateDistributionResponse :: Type -> Type #

Methods

from :: CreateDistributionResponse -> Rep CreateDistributionResponse x #

to :: Rep CreateDistributionResponse x -> CreateDistributionResponse #

NFData CreateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

Methods

rnf :: CreateDistributionResponse -> () #

type Rep CreateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateDistribution

type Rep CreateDistributionResponse = D1 ('MetaData "CreateDistributionResponse" "Amazonka.Lightsail.CreateDistribution" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "CreateDistributionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "distribution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LightsailDistribution)) :*: (S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Operation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateDistributionResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateDistributionResponse'

-> CreateDistributionResponse 

Create a value of CreateDistributionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:distribution:CreateDistributionResponse', createDistributionResponse_distribution - An object that describes the distribution created.

$sel:operation:CreateDistributionResponse', createDistributionResponse_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.

$sel:httpStatus:CreateDistributionResponse', createDistributionResponse_httpStatus - The response's http status code.

Response Lenses

createDistributionResponse_distribution :: Lens' CreateDistributionResponse (Maybe LightsailDistribution) Source #

An object that describes the distribution created.

createDistributionResponse_operation :: Lens' CreateDistributionResponse (Maybe Operation) Source #

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.

createDistributionResponse_httpStatus :: Lens' CreateDistributionResponse Int Source #

The response's http status code.