Amazonka.ServiceCatalog.UpdateConstraint

Updates the specified constraint.

Creating a Request

data UpdateConstraint

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

ToJSON UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

toJSON :: UpdateConstraint -> Value

toEncoding :: UpdateConstraint -> Encoding

toJSONList :: [UpdateConstraint] -> Value

toEncodingList :: [UpdateConstraint] -> Encoding

ToHeaders UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

toHeaders :: UpdateConstraint -> [Header]

ToPath UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

toPath :: UpdateConstraint -> ByteString

ToQuery UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

toQuery :: UpdateConstraint -> QueryString

AWSRequest UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Associated Types

type AWSResponse UpdateConstraint

Methods

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

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

Generic UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Associated Types

type Rep UpdateConstraint :: Type -> Type

Methods

from :: UpdateConstraint -> Rep UpdateConstraint x

to :: Rep UpdateConstraint x -> UpdateConstraint

Read UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

readsPrec :: Int -> ReadS UpdateConstraint

readList :: ReadS [UpdateConstraint]

readPrec :: ReadPrec UpdateConstraint

readListPrec :: ReadPrec [UpdateConstraint]

Show UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

showsPrec :: Int -> UpdateConstraint -> ShowS

show :: UpdateConstraint -> String

showList :: [UpdateConstraint] -> ShowS

NFData UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

rnf :: UpdateConstraint -> ()

Eq UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

(==) :: UpdateConstraint -> UpdateConstraint -> Bool

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

Hashable UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

hashWithSalt :: Int -> UpdateConstraint -> Int

hash :: UpdateConstraint -> Int

type AWSResponse UpdateConstraint

Defined in Amazonka.ServiceCatalog.UpdateConstraint

type AWSResponse UpdateConstraint = UpdateConstraintResponse

type Rep UpdateConstraint

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

Arguments

:: Text

UpdateConstraint

-> UpdateConstraint

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)

The language code.

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

updateConstraint_description :: Lens' UpdateConstraint (Maybe Text)

The updated description of the constraint.

updateConstraint_parameters :: Lens' UpdateConstraint (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.

updateConstraint_id :: Lens' UpdateConstraint Text

The identifier of the constraint.

Destructuring the Response

data UpdateConstraintResponse

See: newUpdateConstraintResponse smart constructor.

Constructors

UpdateConstraintResponse'

Fields

• constraintDetail :: Maybe ConstraintDetail

  Information about the constraint.

• constraintParameters :: Maybe Text

  The constraint parameters.

• status :: Maybe RequestStatus

  The status of the current request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateConstraintResponse

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Associated Types

type Rep UpdateConstraintResponse :: Type -> Type

Methods

from :: UpdateConstraintResponse -> Rep UpdateConstraintResponse x

to :: Rep UpdateConstraintResponse x -> UpdateConstraintResponse

Read UpdateConstraintResponse

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

readsPrec :: Int -> ReadS UpdateConstraintResponse

readList :: ReadS [UpdateConstraintResponse]

readPrec :: ReadPrec UpdateConstraintResponse

readListPrec :: ReadPrec [UpdateConstraintResponse]

Show UpdateConstraintResponse

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

showsPrec :: Int -> UpdateConstraintResponse -> ShowS

show :: UpdateConstraintResponse -> String

showList :: [UpdateConstraintResponse] -> ShowS

NFData UpdateConstraintResponse

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

rnf :: UpdateConstraintResponse -> ()

Eq UpdateConstraintResponse

Defined in Amazonka.ServiceCatalog.UpdateConstraint

Methods

(==) :: UpdateConstraintResponse -> UpdateConstraintResponse -> Bool

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

type Rep UpdateConstraintResponse

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

Arguments

:: Int

$sel:httpStatus:UpdateConstraintResponse'

-> UpdateConstraintResponse

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

updateConstraintResponse_constraintDetail :: Lens' UpdateConstraintResponse (Maybe ConstraintDetail)

Information about the constraint.

updateConstraintResponse_constraintParameters :: Lens' UpdateConstraintResponse (Maybe Text)

The constraint parameters.

updateConstraintResponse_status :: Lens' UpdateConstraintResponse (Maybe RequestStatus)

The status of the current request.

updateConstraintResponse_httpStatus :: Lens' UpdateConstraintResponse Int

The response's http status code.