Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ServiceCatalog.CreateConstraint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a constraint.

A delegated admin is authorized to invoke this command.

Synopsis

data CreateConstraint = CreateConstraint' {
- acceptLanguage :: Maybe Text
- description :: Maybe Text
- portfolioId :: Text
- productId :: Text
- parameters :: Text
- type' :: Text
- idempotencyToken :: Text
}
newCreateConstraint :: Text -> Text -> Text -> Text -> Text -> CreateConstraint
createConstraint_acceptLanguage :: Lens' CreateConstraint (Maybe Text)
createConstraint_description :: Lens' CreateConstraint (Maybe Text)
createConstraint_portfolioId :: Lens' CreateConstraint Text
createConstraint_productId :: Lens' CreateConstraint Text
createConstraint_parameters :: Lens' CreateConstraint Text
createConstraint_type :: Lens' CreateConstraint Text
createConstraint_idempotencyToken :: Lens' CreateConstraint Text
data CreateConstraintResponse = CreateConstraintResponse' {
- constraintDetail :: Maybe ConstraintDetail
- constraintParameters :: Maybe Text
- status :: Maybe RequestStatus
- httpStatus :: Int
}
newCreateConstraintResponse :: Int -> CreateConstraintResponse
createConstraintResponse_constraintDetail :: Lens' CreateConstraintResponse (Maybe ConstraintDetail)
createConstraintResponse_constraintParameters :: Lens' CreateConstraintResponse (Maybe Text)
createConstraintResponse_status :: Lens' CreateConstraintResponse (Maybe RequestStatus)
createConstraintResponse_httpStatus :: Lens' CreateConstraintResponse Int

Creating a Request

data CreateConstraint Source #

See: newCreateConstraint smart constructor.

Constructors

CreateConstraint'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
description :: Maybe Text
The description of the constraint.
portfolioId :: Text
The portfolio identifier.
productId :: Text
The product identifier.
parameters :: 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.

type' :: Text

The type of constraint.

```
LAUNCH
```
```
NOTIFICATION
```
```
RESOURCE_UPDATE
```
```
STACKSET
```
```
TEMPLATE
```

idempotencyToken :: Text
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

Instances

Instances details

ToJSON CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods toJSON :: CreateConstraint -> Value # toEncoding :: CreateConstraint -> Encoding # toJSONList :: [CreateConstraint] -> Value # toEncodingList :: [CreateConstraint] -> Encoding #
ToHeaders CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods toHeaders :: CreateConstraint -> [Header] #
ToPath CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods toPath :: CreateConstraint -> ByteString #
ToQuery CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods toQuery :: CreateConstraint -> QueryString #
AWSRequest CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Associated Types type AWSResponse CreateConstraint # Methods request :: (Service -> Service) -> CreateConstraint -> Request CreateConstraint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateConstraint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateConstraint))) #
Generic CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Associated Types type Rep CreateConstraint :: Type -> Type # Methods from :: CreateConstraint -> Rep CreateConstraint x # to :: Rep CreateConstraint x -> CreateConstraint #
Read CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods readsPrec :: Int -> ReadS CreateConstraint # readList :: ReadS [CreateConstraint] # readPrec :: ReadPrec CreateConstraint # readListPrec :: ReadPrec [CreateConstraint] #
Show CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods showsPrec :: Int -> CreateConstraint -> ShowS # show :: CreateConstraint -> String # showList :: [CreateConstraint] -> ShowS #
NFData CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods rnf :: CreateConstraint -> () #
Eq CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods (==) :: CreateConstraint -> CreateConstraint -> Bool # (/=) :: CreateConstraint -> CreateConstraint -> Bool #
Hashable CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods hashWithSalt :: Int -> CreateConstraint -> Int # hash :: CreateConstraint -> Int #
type AWSResponse CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint type AWSResponse CreateConstraint = CreateConstraintResponse
type Rep CreateConstraint Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint type Rep CreateConstraint = D1 ('MetaData "CreateConstraint" "Amazonka.ServiceCatalog.CreateConstraint" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "CreateConstraint'" '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 "portfolioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "productId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateConstraint Source #

Arguments

:: Text	`CreateConstraint`
-> Text	`CreateConstraint`
-> Text	`$sel:parameters:CreateConstraint'`
-> Text	`CreateConstraint`
-> Text	`CreateConstraint`
-> CreateConstraint

Create a value of CreateConstraint 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:CreateConstraint', createConstraint_acceptLanguage - The language code.

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

CreateConstraint, createConstraint_description - The description of the constraint.

CreateConstraint, createConstraint_portfolioId - The portfolio identifier.

CreateConstraint, createConstraint_productId - The product identifier.

$sel:parameters:CreateConstraint', createConstraint_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.

CreateConstraint, createConstraint_type - The type of constraint.

```
LAUNCH
```
```
NOTIFICATION
```
```
RESOURCE_UPDATE
```
```
STACKSET
```
```
TEMPLATE
```

CreateConstraint, createConstraint_idempotencyToken - A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

Request Lenses

createConstraint_acceptLanguage :: Lens' CreateConstraint (Maybe Text) Source #

The language code.

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

createConstraint_description :: Lens' CreateConstraint (Maybe Text) Source #

The description of the constraint.

createConstraint_portfolioId :: Lens' CreateConstraint Text Source #

The portfolio identifier.

createConstraint_productId :: Lens' CreateConstraint Text Source #

The product identifier.

createConstraint_parameters :: Lens' CreateConstraint 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.

createConstraint_type :: Lens' CreateConstraint Text Source #

The type of constraint.

```
LAUNCH
```
```
NOTIFICATION
```
```
RESOURCE_UPDATE
```
```
STACKSET
```
```
TEMPLATE
```

createConstraint_idempotencyToken :: Lens' CreateConstraint Text Source #

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

Destructuring the Response

data CreateConstraintResponse Source #

See: newCreateConstraintResponse smart constructor.

Constructors

CreateConstraintResponse'
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

Instances details

Generic CreateConstraintResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Associated Types type Rep CreateConstraintResponse :: Type -> Type # Methods from :: CreateConstraintResponse -> Rep CreateConstraintResponse x # to :: Rep CreateConstraintResponse x -> CreateConstraintResponse #
Read CreateConstraintResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods readsPrec :: Int -> ReadS CreateConstraintResponse # readList :: ReadS [CreateConstraintResponse] # readPrec :: ReadPrec CreateConstraintResponse # readListPrec :: ReadPrec [CreateConstraintResponse] #
Show CreateConstraintResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods showsPrec :: Int -> CreateConstraintResponse -> ShowS # show :: CreateConstraintResponse -> String # showList :: [CreateConstraintResponse] -> ShowS #
NFData CreateConstraintResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods rnf :: CreateConstraintResponse -> () #
Eq CreateConstraintResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint Methods (==) :: CreateConstraintResponse -> CreateConstraintResponse -> Bool # (/=) :: CreateConstraintResponse -> CreateConstraintResponse -> Bool #
type Rep CreateConstraintResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateConstraint type Rep CreateConstraintResponse = D1 ('MetaData "CreateConstraintResponse" "Amazonka.ServiceCatalog.CreateConstraint" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "CreateConstraintResponse'" '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))))