Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Updates the specified constraint.
Synopsis
- data UpdateConstraint = UpdateConstraint' {
- acceptLanguage :: Maybe Text
- parameters :: Maybe Text
- description :: Maybe Text
- id :: Text
- newUpdateConstraint :: Text -> UpdateConstraint
- updateConstraint_acceptLanguage :: Lens' UpdateConstraint (Maybe Text)
- updateConstraint_parameters :: Lens' UpdateConstraint (Maybe Text)
- updateConstraint_description :: Lens' UpdateConstraint (Maybe Text)
- updateConstraint_id :: Lens' UpdateConstraint Text
- data UpdateConstraintResponse = UpdateConstraintResponse' {}
- newUpdateConstraintResponse :: Int -> UpdateConstraintResponse
- updateConstraintResponse_status :: Lens' UpdateConstraintResponse (Maybe RequestStatus)
- updateConstraintResponse_constraintDetail :: Lens' UpdateConstraintResponse (Maybe ConstraintDetail)
- updateConstraintResponse_constraintParameters :: Lens' UpdateConstraintResponse (Maybe Text)
- updateConstraintResponse_httpStatus :: Lens' UpdateConstraintResponse Int
Creating a Request
data UpdateConstraint Source #
See: newUpdateConstraint
smart constructor.
UpdateConstraint' | |
|
Instances
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
- Japanesezh
- Chinese
$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 theLocalRoleName
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 aSTACKSET
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 ofALLOWED
orNOT_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 aSTACKSET
constraint.You also cannot have more than one
STACKSET
constraint on a product and portfolio.Products with a
STACKSET
constraint will launch an AWS CloudFormation stack set. - TEMPLATE
- Specify the
Rules
property. For more information, see Template Constraint Rules.
$sel:description:UpdateConstraint'
, updateConstraint_description
- The updated description of the constraint.
$sel:id:UpdateConstraint'
, updateConstraint_id
- The identifier of the constraint.
Request Lenses
updateConstraint_acceptLanguage :: Lens' UpdateConstraint (Maybe Text) Source #
The language code.
en
- English (default)jp
- Japanesezh
- Chinese
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 theLocalRoleName
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 aSTACKSET
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 ofALLOWED
orNOT_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 aSTACKSET
constraint.You also cannot have more than one
STACKSET
constraint on a product and portfolio.Products with a
STACKSET
constraint will launch an AWS CloudFormation stack set. - TEMPLATE
- Specify the
Rules
property. For more information, see Template Constraint Rules.
updateConstraint_description :: Lens' UpdateConstraint (Maybe Text) Source #
The updated description of the constraint.
updateConstraint_id :: Lens' UpdateConstraint Text Source #
The identifier of the constraint.
Destructuring the Response
data UpdateConstraintResponse Source #
See: newUpdateConstraintResponse
smart constructor.
UpdateConstraintResponse' | |
|
Instances
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:status:UpdateConstraintResponse'
, updateConstraintResponse_status
- The status of the current request.
$sel:constraintDetail:UpdateConstraintResponse'
, updateConstraintResponse_constraintDetail
- Information about the constraint.
$sel:constraintParameters:UpdateConstraintResponse'
, updateConstraintResponse_constraintParameters
- The constraint parameters.
$sel:httpStatus:UpdateConstraintResponse'
, updateConstraintResponse_httpStatus
- The response's http status code.
Response Lenses
updateConstraintResponse_status :: Lens' UpdateConstraintResponse (Maybe RequestStatus) Source #
The status of the current request.
updateConstraintResponse_constraintDetail :: Lens' UpdateConstraintResponse (Maybe ConstraintDetail) Source #
Information about the constraint.
updateConstraintResponse_constraintParameters :: Lens' UpdateConstraintResponse (Maybe Text) Source #
The constraint parameters.
updateConstraintResponse_httpStatus :: Lens' UpdateConstraintResponse Int Source #
The response's http status code.