amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.EstimateTemplateCost

Description

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

Synopsis

Creating a Request

data EstimateTemplateCost Source #

The input for an EstimateTemplateCost action.

See: newEstimateTemplateCost smart constructor.

Constructors

EstimateTemplateCost' 

Fields

  • parameters :: Maybe [Parameter]

    A list of Parameter structures that specify input parameters.

  • templateBody :: Maybe Text

    Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

    Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

  • templateURL :: Maybe Text

    Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

    Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Instances

Instances details
ToHeaders EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

ToPath EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

ToQuery EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

AWSRequest EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

Associated Types

type AWSResponse EstimateTemplateCost #

Generic EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

Associated Types

type Rep EstimateTemplateCost :: Type -> Type #

Read EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

Show EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

NFData EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

Methods

rnf :: EstimateTemplateCost -> () #

Eq EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

Hashable EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

type AWSResponse EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

type Rep EstimateTemplateCost Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

type Rep EstimateTemplateCost = D1 ('MetaData "EstimateTemplateCost" "Amazonka.CloudFormation.EstimateTemplateCost" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "EstimateTemplateCost'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :*: (S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newEstimateTemplateCost :: EstimateTemplateCost Source #

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

EstimateTemplateCost, estimateTemplateCost_parameters - A list of Parameter structures that specify input parameters.

EstimateTemplateCost, estimateTemplateCost_templateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

$sel:templateURL:EstimateTemplateCost', estimateTemplateCost_templateURL - Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Request Lenses

estimateTemplateCost_parameters :: Lens' EstimateTemplateCost (Maybe [Parameter]) Source #

A list of Parameter structures that specify input parameters.

estimateTemplateCost_templateBody :: Lens' EstimateTemplateCost (Maybe Text) Source #

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

estimateTemplateCost_templateURL :: Lens' EstimateTemplateCost (Maybe Text) Source #

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

Destructuring the Response

data EstimateTemplateCostResponse Source #

The output for a EstimateTemplateCost action.

See: newEstimateTemplateCostResponse smart constructor.

Constructors

EstimateTemplateCostResponse' 

Fields

  • url :: Maybe Text

    An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic EstimateTemplateCostResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

Associated Types

type Rep EstimateTemplateCostResponse :: Type -> Type #

Read EstimateTemplateCostResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

Show EstimateTemplateCostResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

NFData EstimateTemplateCostResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

Eq EstimateTemplateCostResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

type Rep EstimateTemplateCostResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.EstimateTemplateCost

type Rep EstimateTemplateCostResponse = D1 ('MetaData "EstimateTemplateCostResponse" "Amazonka.CloudFormation.EstimateTemplateCost" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "EstimateTemplateCostResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newEstimateTemplateCostResponse Source #

Create a value of EstimateTemplateCostResponse 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:url:EstimateTemplateCostResponse', estimateTemplateCostResponse_url - An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

$sel:httpStatus:EstimateTemplateCostResponse', estimateTemplateCostResponse_httpStatus - The response's http status code.

Response Lenses

estimateTemplateCostResponse_url :: Lens' EstimateTemplateCostResponse (Maybe Text) Source #

An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.