Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lightsail.CreateDistribution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data CreateDistribution = CreateDistribution' {
- cacheBehaviorSettings :: Maybe CacheSettings
- cacheBehaviors :: Maybe [CacheBehaviorPerPath]
- ipAddressType :: Maybe IpAddressType
- tags :: Maybe [Tag]
- distributionName :: Text
- origin :: InputOrigin
- defaultCacheBehavior :: CacheBehavior
- bundleId :: Text
}
newCreateDistribution :: Text -> InputOrigin -> CacheBehavior -> Text -> CreateDistribution
createDistribution_cacheBehaviorSettings :: Lens' CreateDistribution (Maybe CacheSettings)
createDistribution_cacheBehaviors :: Lens' CreateDistribution (Maybe [CacheBehaviorPerPath])
createDistribution_ipAddressType :: Lens' CreateDistribution (Maybe IpAddressType)
createDistribution_tags :: Lens' CreateDistribution (Maybe [Tag])
createDistribution_distributionName :: Lens' CreateDistribution Text
createDistribution_origin :: Lens' CreateDistribution InputOrigin
createDistribution_defaultCacheBehavior :: Lens' CreateDistribution CacheBehavior
createDistribution_bundleId :: Lens' CreateDistribution Text
data CreateDistributionResponse = CreateDistributionResponse' {
- distribution :: Maybe LightsailDistribution
- operation :: Maybe Operation
- httpStatus :: Int
}
newCreateDistributionResponse :: Int -> CreateDistributionResponse
createDistributionResponse_distribution :: Lens' CreateDistributionResponse (Maybe LightsailDistribution)
createDistributionResponse_operation :: Lens' CreateDistributionResponse (Maybe Operation)
createDistributionResponse_httpStatus :: Lens' CreateDistributionResponse Int

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.
cacheBehaviors :: Maybe [CacheBehaviorPerPath]
An array of objects that describe the per-path cache behavior 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.
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, bucket, 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

ToJSON CreateDistribution Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution Methods toJSON :: CreateDistribution -> Value # toEncoding :: CreateDistribution -> Encoding # toJSONList :: [CreateDistribution] -> Value # toEncodingList :: [CreateDistribution] -> Encoding #
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 #
AWSRequest CreateDistribution Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution Associated Types type AWSResponse CreateDistribution # Methods request :: (Service -> Service) -> CreateDistribution -> Request CreateDistribution # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDistribution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDistribution))) #
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 #
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 #
NFData CreateDistribution Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution Methods rnf :: CreateDistribution -> () #
Eq CreateDistribution Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution Methods (==) :: CreateDistribution -> CreateDistribution -> Bool # (/=) :: CreateDistribution -> CreateDistribution -> Bool #
Hashable CreateDistribution Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution Methods hashWithSalt :: Int -> CreateDistribution -> Int # hash :: CreateDistribution -> Int #
type AWSResponse CreateDistribution Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution type AWSResponse CreateDistribution = CreateDistributionResponse
type Rep CreateDistribution Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution type Rep CreateDistribution = D1 ('MetaData "CreateDistribution" "Amazonka.Lightsail.CreateDistribution" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "CreateDistribution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheBehaviorSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheSettings)) :: S1 ('MetaSel ('Just "cacheBehaviors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CacheBehaviorPerPath]))) :: (S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType)) :: 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)))))

newCreateDistribution Source #

Arguments

:: Text	`$sel:distributionName:CreateDistribution'`
-> InputOrigin	`CreateDistribution`
-> CacheBehavior	`CreateDistribution`
-> Text	`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:

CreateDistribution, createDistribution_cacheBehaviorSettings - An object that describes the cache behavior settings for the distribution.

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

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.

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.

CreateDistribution, createDistribution_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.

CreateDistribution, createDistribution_defaultCacheBehavior - An object that describes the default cache behavior for the distribution.

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_cacheBehaviors :: Lens' CreateDistribution (Maybe [CacheBehaviorPerPath]) Source #

An array of objects that describe the per-path cache behavior 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_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, bucket, 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 distribution :: Maybe LightsailDistribution An object that describes the distribution created. operation :: Maybe 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. httpStatus :: Int The response's http status code.

Instances

Instances details

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 #
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 #
NFData CreateDistributionResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution Methods rnf :: CreateDistributionResponse -> () #
Eq CreateDistributionResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution Methods (==) :: CreateDistributionResponse -> CreateDistributionResponse -> Bool # (/=) :: CreateDistributionResponse -> CreateDistributionResponse -> Bool #
type Rep CreateDistributionResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateDistribution type Rep CreateDistributionResponse = D1 ('MetaData "CreateDistributionResponse" "Amazonka.Lightsail.CreateDistribution" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" '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.