AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | List of all members
Aws::ServiceCatalog::Model::CreateConstraintRequest Class Reference

#include <CreateConstraintRequest.h>

+ Inheritance diagram for Aws::ServiceCatalog::Model::CreateConstraintRequest:

Public Member Functions

 CreateConstraintRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAcceptLanguage () const
 
bool AcceptLanguageHasBeenSet () const
 
void SetAcceptLanguage (const Aws::String &value)
 
void SetAcceptLanguage (Aws::String &&value)
 
void SetAcceptLanguage (const char *value)
 
CreateConstraintRequestWithAcceptLanguage (const Aws::String &value)
 
CreateConstraintRequestWithAcceptLanguage (Aws::String &&value)
 
CreateConstraintRequestWithAcceptLanguage (const char *value)
 
const Aws::StringGetPortfolioId () const
 
bool PortfolioIdHasBeenSet () const
 
void SetPortfolioId (const Aws::String &value)
 
void SetPortfolioId (Aws::String &&value)
 
void SetPortfolioId (const char *value)
 
CreateConstraintRequestWithPortfolioId (const Aws::String &value)
 
CreateConstraintRequestWithPortfolioId (Aws::String &&value)
 
CreateConstraintRequestWithPortfolioId (const char *value)
 
const Aws::StringGetProductId () const
 
bool ProductIdHasBeenSet () const
 
void SetProductId (const Aws::String &value)
 
void SetProductId (Aws::String &&value)
 
void SetProductId (const char *value)
 
CreateConstraintRequestWithProductId (const Aws::String &value)
 
CreateConstraintRequestWithProductId (Aws::String &&value)
 
CreateConstraintRequestWithProductId (const char *value)
 
const Aws::StringGetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::String &value)
 
void SetParameters (Aws::String &&value)
 
void SetParameters (const char *value)
 
CreateConstraintRequestWithParameters (const Aws::String &value)
 
CreateConstraintRequestWithParameters (Aws::String &&value)
 
CreateConstraintRequestWithParameters (const char *value)
 
const Aws::StringGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const Aws::String &value)
 
void SetType (Aws::String &&value)
 
void SetType (const char *value)
 
CreateConstraintRequestWithType (const Aws::String &value)
 
CreateConstraintRequestWithType (Aws::String &&value)
 
CreateConstraintRequestWithType (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateConstraintRequestWithDescription (const Aws::String &value)
 
CreateConstraintRequestWithDescription (Aws::String &&value)
 
CreateConstraintRequestWithDescription (const char *value)
 
const Aws::StringGetIdempotencyToken () const
 
bool IdempotencyTokenHasBeenSet () const
 
void SetIdempotencyToken (const Aws::String &value)
 
void SetIdempotencyToken (Aws::String &&value)
 
void SetIdempotencyToken (const char *value)
 
CreateConstraintRequestWithIdempotencyToken (const Aws::String &value)
 
CreateConstraintRequestWithIdempotencyToken (Aws::String &&value)
 
CreateConstraintRequestWithIdempotencyToken (const char *value)
 
- Public Member Functions inherited from Aws::ServiceCatalog::ServiceCatalogRequest
virtual ~ServiceCatalogRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file CreateConstraintRequest.h.

Constructor & Destructor Documentation

◆ CreateConstraintRequest()

Aws::ServiceCatalog::Model::CreateConstraintRequest::CreateConstraintRequest ( )

Member Function Documentation

◆ AcceptLanguageHasBeenSet()

bool Aws::ServiceCatalog::Model::CreateConstraintRequest::AcceptLanguageHasBeenSet ( ) const
inline

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Definition at line 50 of file CreateConstraintRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::ServiceCatalog::Model::CreateConstraintRequest::DescriptionHasBeenSet ( ) const
inline

The description of the constraint.

Definition at line 555 of file CreateConstraintRequest.h.

◆ GetAcceptLanguage()

const Aws::String& Aws::ServiceCatalog::Model::CreateConstraintRequest::GetAcceptLanguage ( ) const
inline

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Definition at line 43 of file CreateConstraintRequest.h.

◆ GetDescription()

const Aws::String& Aws::ServiceCatalog::Model::CreateConstraintRequest::GetDescription ( ) const
inline

The description of the constraint.

Definition at line 550 of file CreateConstraintRequest.h.

◆ GetIdempotencyToken()

const Aws::String& Aws::ServiceCatalog::Model::CreateConstraintRequest::GetIdempotencyToken ( ) const
inline

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.

Definition at line 593 of file CreateConstraintRequest.h.

◆ GetParameters()

const Aws::String& Aws::ServiceCatalog::Model::CreateConstraintRequest::GetParameters ( ) const
inline

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 AWS CloudFormation stack set.

TEMPLATE

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

Definition at line 213 of file CreateConstraintRequest.h.

◆ GetPortfolioId()

const Aws::String& Aws::ServiceCatalog::Model::CreateConstraintRequest::GetPortfolioId ( ) const
inline

The portfolio identifier.

Definition at line 98 of file CreateConstraintRequest.h.

◆ GetProductId()

const Aws::String& Aws::ServiceCatalog::Model::CreateConstraintRequest::GetProductId ( ) const
inline

The product identifier.

Definition at line 139 of file CreateConstraintRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ServiceCatalog::Model::CreateConstraintRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::ServiceCatalog::Model::CreateConstraintRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file CreateConstraintRequest.h.

◆ GetType()

const Aws::String& Aws::ServiceCatalog::Model::CreateConstraintRequest::GetType ( ) const
inline

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Definition at line 488 of file CreateConstraintRequest.h.

◆ IdempotencyTokenHasBeenSet()

bool Aws::ServiceCatalog::Model::CreateConstraintRequest::IdempotencyTokenHasBeenSet ( ) const
inline

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.

Definition at line 600 of file CreateConstraintRequest.h.

◆ ParametersHasBeenSet()

bool Aws::ServiceCatalog::Model::CreateConstraintRequest::ParametersHasBeenSet ( ) const
inline

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 AWS CloudFormation stack set.

TEMPLATE

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

Definition at line 251 of file CreateConstraintRequest.h.

◆ PortfolioIdHasBeenSet()

bool Aws::ServiceCatalog::Model::CreateConstraintRequest::PortfolioIdHasBeenSet ( ) const
inline

The portfolio identifier.

Definition at line 103 of file CreateConstraintRequest.h.

◆ ProductIdHasBeenSet()

bool Aws::ServiceCatalog::Model::CreateConstraintRequest::ProductIdHasBeenSet ( ) const
inline

The product identifier.

Definition at line 144 of file CreateConstraintRequest.h.

◆ SerializePayload()

Aws::String Aws::ServiceCatalog::Model::CreateConstraintRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAcceptLanguage() [1/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetAcceptLanguage ( Aws::String &&  value)
inline

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Definition at line 64 of file CreateConstraintRequest.h.

◆ SetAcceptLanguage() [2/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetAcceptLanguage ( const Aws::String value)
inline

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Definition at line 57 of file CreateConstraintRequest.h.

◆ SetAcceptLanguage() [3/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetAcceptLanguage ( const char *  value)
inline

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Definition at line 71 of file CreateConstraintRequest.h.

◆ SetDescription() [1/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetDescription ( Aws::String &&  value)
inline

The description of the constraint.

Definition at line 565 of file CreateConstraintRequest.h.

◆ SetDescription() [2/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetDescription ( const Aws::String value)
inline

The description of the constraint.

Definition at line 560 of file CreateConstraintRequest.h.

◆ SetDescription() [3/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetDescription ( const char *  value)
inline

The description of the constraint.

Definition at line 570 of file CreateConstraintRequest.h.

◆ SetIdempotencyToken() [1/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetIdempotencyToken ( Aws::String &&  value)
inline

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.

Definition at line 614 of file CreateConstraintRequest.h.

◆ SetIdempotencyToken() [2/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetIdempotencyToken ( const Aws::String value)
inline

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.

Definition at line 607 of file CreateConstraintRequest.h.

◆ SetIdempotencyToken() [3/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetIdempotencyToken ( const char *  value)
inline

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.

Definition at line 621 of file CreateConstraintRequest.h.

◆ SetParameters() [1/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetParameters ( Aws::String &&  value)
inline

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 AWS CloudFormation stack set.

TEMPLATE

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

Definition at line 327 of file CreateConstraintRequest.h.

◆ SetParameters() [2/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetParameters ( const Aws::String value)
inline

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 AWS CloudFormation stack set.

TEMPLATE

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

Definition at line 289 of file CreateConstraintRequest.h.

◆ SetParameters() [3/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetParameters ( const char *  value)
inline

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 AWS CloudFormation stack set.

TEMPLATE

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

Definition at line 365 of file CreateConstraintRequest.h.

◆ SetPortfolioId() [1/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetPortfolioId ( Aws::String &&  value)
inline

The portfolio identifier.

Definition at line 113 of file CreateConstraintRequest.h.

◆ SetPortfolioId() [2/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetPortfolioId ( const Aws::String value)
inline

The portfolio identifier.

Definition at line 108 of file CreateConstraintRequest.h.

◆ SetPortfolioId() [3/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetPortfolioId ( const char *  value)
inline

The portfolio identifier.

Definition at line 118 of file CreateConstraintRequest.h.

◆ SetProductId() [1/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetProductId ( Aws::String &&  value)
inline

The product identifier.

Definition at line 154 of file CreateConstraintRequest.h.

◆ SetProductId() [2/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetProductId ( const Aws::String value)
inline

The product identifier.

Definition at line 149 of file CreateConstraintRequest.h.

◆ SetProductId() [3/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetProductId ( const char *  value)
inline

The product identifier.

Definition at line 159 of file CreateConstraintRequest.h.

◆ SetType() [1/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetType ( Aws::String &&  value)
inline

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Definition at line 512 of file CreateConstraintRequest.h.

◆ SetType() [2/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetType ( const Aws::String value)
inline

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Definition at line 504 of file CreateConstraintRequest.h.

◆ SetType() [3/3]

void Aws::ServiceCatalog::Model::CreateConstraintRequest::SetType ( const char *  value)
inline

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Definition at line 520 of file CreateConstraintRequest.h.

◆ TypeHasBeenSet()

bool Aws::ServiceCatalog::Model::CreateConstraintRequest::TypeHasBeenSet ( ) const
inline

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Definition at line 496 of file CreateConstraintRequest.h.

◆ WithAcceptLanguage() [1/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithAcceptLanguage ( Aws::String &&  value)
inline

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Definition at line 85 of file CreateConstraintRequest.h.

◆ WithAcceptLanguage() [2/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithAcceptLanguage ( const Aws::String value)
inline

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Definition at line 78 of file CreateConstraintRequest.h.

◆ WithAcceptLanguage() [3/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithAcceptLanguage ( const char *  value)
inline

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Definition at line 92 of file CreateConstraintRequest.h.

◆ WithDescription() [1/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithDescription ( Aws::String &&  value)
inline

The description of the constraint.

Definition at line 580 of file CreateConstraintRequest.h.

◆ WithDescription() [2/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithDescription ( const Aws::String value)
inline

The description of the constraint.

Definition at line 575 of file CreateConstraintRequest.h.

◆ WithDescription() [3/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithDescription ( const char *  value)
inline

The description of the constraint.

Definition at line 585 of file CreateConstraintRequest.h.

◆ WithIdempotencyToken() [1/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithIdempotencyToken ( Aws::String &&  value)
inline

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.

Definition at line 635 of file CreateConstraintRequest.h.

◆ WithIdempotencyToken() [2/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithIdempotencyToken ( const Aws::String value)
inline

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.

Definition at line 628 of file CreateConstraintRequest.h.

◆ WithIdempotencyToken() [3/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithIdempotencyToken ( const char *  value)
inline

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.

Definition at line 642 of file CreateConstraintRequest.h.

◆ WithParameters() [1/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithParameters ( Aws::String &&  value)
inline

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 AWS CloudFormation stack set.

TEMPLATE

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

Definition at line 441 of file CreateConstraintRequest.h.

◆ WithParameters() [2/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithParameters ( const Aws::String value)
inline

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 AWS CloudFormation stack set.

TEMPLATE

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

Definition at line 403 of file CreateConstraintRequest.h.

◆ WithParameters() [3/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithParameters ( const char *  value)
inline

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 AWS CloudFormation stack set.

TEMPLATE

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

Definition at line 479 of file CreateConstraintRequest.h.

◆ WithPortfolioId() [1/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithPortfolioId ( Aws::String &&  value)
inline

The portfolio identifier.

Definition at line 128 of file CreateConstraintRequest.h.

◆ WithPortfolioId() [2/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithPortfolioId ( const Aws::String value)
inline

The portfolio identifier.

Definition at line 123 of file CreateConstraintRequest.h.

◆ WithPortfolioId() [3/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithPortfolioId ( const char *  value)
inline

The portfolio identifier.

Definition at line 133 of file CreateConstraintRequest.h.

◆ WithProductId() [1/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithProductId ( Aws::String &&  value)
inline

The product identifier.

Definition at line 169 of file CreateConstraintRequest.h.

◆ WithProductId() [2/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithProductId ( const Aws::String value)
inline

The product identifier.

Definition at line 164 of file CreateConstraintRequest.h.

◆ WithProductId() [3/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithProductId ( const char *  value)
inline

The product identifier.

Definition at line 174 of file CreateConstraintRequest.h.

◆ WithType() [1/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithType ( Aws::String &&  value)
inline

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Definition at line 536 of file CreateConstraintRequest.h.

◆ WithType() [2/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithType ( const Aws::String value)
inline

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Definition at line 528 of file CreateConstraintRequest.h.

◆ WithType() [3/3]

CreateConstraintRequest& Aws::ServiceCatalog::Model::CreateConstraintRequest::WithType ( const char *  value)
inline

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Definition at line 544 of file CreateConstraintRequest.h.


The documentation for this class was generated from the following file: