amazonka-servicecatalog-2.0: Amazon Service Catalog 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.ServiceCatalog.UpdateConstraint

Description

Updates the specified constraint.

Synopsis

Creating a Request

data UpdateConstraint Source #

See: newUpdateConstraint smart constructor.

Constructors

UpdateConstraint' 

Fields

  • acceptLanguage :: Maybe Text

    The language code.

    • en - English (default)
    • jp - Japanese
    • zh - Chinese
  • description :: Maybe Text

    The updated description of the constraint.

  • parameters :: Maybe Text

    The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

    LAUNCH
    You are required to specify either the RoleArn or the LocalRoleName but can't use both.

    Specify the RoleArn property as follows:

    {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

    Specify the LocalRoleName property as follows:

    {"LocalRoleName": "SCBasicLaunchRole"}

    If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

    The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one LAUNCH constraint on a product and portfolio.

    NOTIFICATION
    Specify the NotificationArns property as follows:
    {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}
    RESOURCE_UPDATE
    Specify the TagUpdatesOnProvisionedProduct property as follows:
    {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

    The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

    STACKSET
    Specify the Parameters property as follows:
    {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one STACKSET constraint on a product and portfolio.

    Products with a STACKSET constraint will launch an CloudFormation stack set.

    TEMPLATE
    Specify the Rules property. For more information, see Template Constraint Rules.
  • id :: Text

    The identifier of the constraint.

Instances

Instances details
ToJSON UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

ToHeaders UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

ToPath UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

ToQuery UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

AWSRequest UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Associated Types

type AWSResponse UpdateConstraint #

Generic UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Associated Types

type Rep UpdateConstraint :: Type -> Type #

Read UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Show UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

NFData UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

rnf :: UpdateConstraint -> () #

Eq UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Hashable UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

type AWSResponse UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

type Rep UpdateConstraint Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

type Rep UpdateConstraint = D1 ('MetaData "UpdateConstraint" "Amazonka.ServiceCatalog.UpdateConstraint" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "UpdateConstraint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateConstraint Source #

Create a value of UpdateConstraint 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:acceptLanguage:UpdateConstraint', updateConstraint_acceptLanguage - The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

UpdateConstraint, updateConstraint_description - The updated description of the constraint.

$sel:parameters:UpdateConstraint', updateConstraint_parameters - The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH
You are required to specify either the RoleArn or the LocalRoleName but can't use both.

Specify the RoleArn property as follows:

{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION
Specify the NotificationArns property as follows:
{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}
RESOURCE_UPDATE
Specify the TagUpdatesOnProvisionedProduct property as follows:
{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET
Specify the Parameters property as follows:
{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one STACKSET constraint on a product and portfolio.

Products with a STACKSET constraint will launch an CloudFormation stack set.

TEMPLATE
Specify the Rules property. For more information, see Template Constraint Rules.

UpdateConstraint, updateConstraint_id - The identifier of the constraint.

Request Lenses

updateConstraint_acceptLanguage :: Lens' UpdateConstraint (Maybe Text) Source #

The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

updateConstraint_description :: Lens' UpdateConstraint (Maybe Text) Source #

The updated description of the constraint.

updateConstraint_parameters :: Lens' UpdateConstraint (Maybe Text) Source #

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH
You are required to specify either the RoleArn or the LocalRoleName but can't use both.

Specify the RoleArn property as follows:

{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION
Specify the NotificationArns property as follows:
{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}
RESOURCE_UPDATE
Specify the TagUpdatesOnProvisionedProduct property as follows:
{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET
Specify the Parameters property as follows:
{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one STACKSET constraint on a product and portfolio.

Products with a STACKSET constraint will launch an CloudFormation stack set.

TEMPLATE
Specify the Rules property. For more information, see Template Constraint Rules.

updateConstraint_id :: Lens' UpdateConstraint Text Source #

The identifier of the constraint.

Destructuring the Response

data UpdateConstraintResponse Source #

See: newUpdateConstraintResponse smart constructor.

Constructors

UpdateConstraintResponse' 

Fields

Instances

Instances details
Generic UpdateConstraintResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Associated Types

type Rep UpdateConstraintResponse :: Type -> Type #

Read UpdateConstraintResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Show UpdateConstraintResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

NFData UpdateConstraintResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Eq UpdateConstraintResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

type Rep UpdateConstraintResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateConstraint

type Rep UpdateConstraintResponse = D1 ('MetaData "UpdateConstraintResponse" "Amazonka.ServiceCatalog.UpdateConstraint" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "UpdateConstraintResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "constraintDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConstraintDetail)) :*: S1 ('MetaSel ('Just "constraintParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateConstraintResponse Source #

Create a value of UpdateConstraintResponse 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:constraintDetail:UpdateConstraintResponse', updateConstraintResponse_constraintDetail - Information about the constraint.

$sel:constraintParameters:UpdateConstraintResponse', updateConstraintResponse_constraintParameters - The constraint parameters.

UpdateConstraintResponse, updateConstraintResponse_status - The status of the current request.

$sel:httpStatus:UpdateConstraintResponse', updateConstraintResponse_httpStatus - The response's http status code.

Response Lenses