Amazonka.CloudFront.CreateFunction

Creates a CloudFront function.

To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.

When you create a function, it's in the DEVELOPMENT stage. In this stage, you can test the function with TestFunction, and update it with UpdateFunction.

When you're ready to use your function with a CloudFront distribution, use PublishFunction to copy the function from the DEVELOPMENT stage to LIVE. When it's live, you can attach the function to a distribution's cache behavior, using the function's ARN.

Creating a Request

data CreateFunction

See: newCreateFunction smart constructor.

Constructors

CreateFunction'

Fields

• name :: Text

  A name to identify the function.

• functionConfig :: FunctionConfig

  Configuration information about the function, including an optional comment and the function's runtime.

• functionCode :: Sensitive Base64

  The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.

Instances

ToHeaders CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Methods

toHeaders :: CreateFunction -> [Header]

ToPath CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Methods

toPath :: CreateFunction -> ByteString

ToQuery CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Methods

toQuery :: CreateFunction -> QueryString

ToElement CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Methods

toElement :: CreateFunction -> Element

ToXML CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Methods

toXML :: CreateFunction -> XML

AWSRequest CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Associated Types

type AWSResponse CreateFunction

Methods

request :: (Service -> Service) -> CreateFunction -> Request CreateFunction

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFunction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFunction)))

Generic CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Associated Types

type Rep CreateFunction :: Type -> Type

Methods

from :: CreateFunction -> Rep CreateFunction x

to :: Rep CreateFunction x -> CreateFunction

Show CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Methods

showsPrec :: Int -> CreateFunction -> ShowS

show :: CreateFunction -> String

showList :: [CreateFunction] -> ShowS

NFData CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Methods

rnf :: CreateFunction -> ()

Eq CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Methods

(==) :: CreateFunction -> CreateFunction -> Bool

(/=) :: CreateFunction -> CreateFunction -> Bool

Hashable CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

Methods

hashWithSalt :: Int -> CreateFunction -> Int

hash :: CreateFunction -> Int

type AWSResponse CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

type AWSResponse CreateFunction = CreateFunctionResponse

type Rep CreateFunction

Defined in Amazonka.CloudFront.CreateFunction

type Rep CreateFunction = D1 ('MetaData "CreateFunction" "Amazonka.CloudFront.CreateFunction" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "CreateFunction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "functionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FunctionConfig) :*: S1 ('MetaSel ('Just "functionCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Base64)))))

newCreateFunction

Arguments

:: Text

CreateFunction

-> FunctionConfig

CreateFunction

-> ByteString

$sel:functionCode:CreateFunction'

-> CreateFunction

Create a value of CreateFunction 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:

CreateFunction, createFunction_name - A name to identify the function.

CreateFunction, createFunction_functionConfig - Configuration information about the function, including an optional comment and the function's runtime.

$sel:functionCode:CreateFunction', createFunction_functionCode - The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Request Lenses

createFunction_name :: Lens' CreateFunction Text

A name to identify the function.

createFunction_functionConfig :: Lens' CreateFunction FunctionConfig

Configuration information about the function, including an optional comment and the function's runtime.

createFunction_functionCode :: Lens' CreateFunction ByteString

The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Destructuring the Response

data CreateFunctionResponse

See: newCreateFunctionResponse smart constructor.

Constructors

CreateFunctionResponse'

Fields

• eTag :: Maybe Text

  The version identifier for the current version of the CloudFront function.

• functionSummary :: Maybe FunctionSummary

  Contains configuration information and metadata about a CloudFront function.

• location :: Maybe Text

  The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateFunctionResponse

Defined in Amazonka.CloudFront.CreateFunction

Associated Types

type Rep CreateFunctionResponse :: Type -> Type

Methods

from :: CreateFunctionResponse -> Rep CreateFunctionResponse x

to :: Rep CreateFunctionResponse x -> CreateFunctionResponse

Read CreateFunctionResponse

Defined in Amazonka.CloudFront.CreateFunction

Methods

readsPrec :: Int -> ReadS CreateFunctionResponse

readList :: ReadS [CreateFunctionResponse]

readPrec :: ReadPrec CreateFunctionResponse

readListPrec :: ReadPrec [CreateFunctionResponse]

Show CreateFunctionResponse

Defined in Amazonka.CloudFront.CreateFunction

Methods

showsPrec :: Int -> CreateFunctionResponse -> ShowS

show :: CreateFunctionResponse -> String

showList :: [CreateFunctionResponse] -> ShowS

NFData CreateFunctionResponse

Defined in Amazonka.CloudFront.CreateFunction

Methods

rnf :: CreateFunctionResponse -> ()

Eq CreateFunctionResponse

Defined in Amazonka.CloudFront.CreateFunction

Methods

(==) :: CreateFunctionResponse -> CreateFunctionResponse -> Bool

(/=) :: CreateFunctionResponse -> CreateFunctionResponse -> Bool

type Rep CreateFunctionResponse

Defined in Amazonka.CloudFront.CreateFunction

type Rep CreateFunctionResponse = D1 ('MetaData "CreateFunctionResponse" "Amazonka.CloudFront.CreateFunction" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "CreateFunctionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "functionSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FunctionSummary))) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateFunctionResponse

Arguments

:: Int

$sel:httpStatus:CreateFunctionResponse'

-> CreateFunctionResponse

Create a value of CreateFunctionResponse 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:eTag:CreateFunctionResponse', createFunctionResponse_eTag - The version identifier for the current version of the CloudFront function.

CreateFunctionResponse, createFunctionResponse_functionSummary - Contains configuration information and metadata about a CloudFront function.

$sel:location:CreateFunctionResponse', createFunctionResponse_location - The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.

$sel:httpStatus:CreateFunctionResponse', createFunctionResponse_httpStatus - The response's http status code.

Response Lenses

createFunctionResponse_eTag :: Lens' CreateFunctionResponse (Maybe Text)

The version identifier for the current version of the CloudFront function.

createFunctionResponse_functionSummary :: Lens' CreateFunctionResponse (Maybe FunctionSummary)

Contains configuration information and metadata about a CloudFront function.

createFunctionResponse_location :: Lens' CreateFunctionResponse (Maybe Text)

The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.

createFunctionResponse_httpStatus :: Lens' CreateFunctionResponse Int

The response's http status code.