/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ServiceCatalog::CreateConstraint

NAME

Paws::ServiceCatalog::CreateConstraint - Arguments for method CreateConstraint on Paws::ServiceCatalog

DESCRIPTION

This class represents the parameters used for calling the method CreateConstraint on the AWS Service Catalog service. Use the attributes of this class as arguments to method CreateConstraint.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateConstraint.

SYNOPSIS

my $servicecatalog = Paws->service('ServiceCatalog');
my $CreateConstraintOutput = $servicecatalog->CreateConstraint(
  IdempotencyToken => 'MyIdempotencyToken',
  Parameters       => 'MyConstraintParameters',
  PortfolioId      => 'MyId',
  ProductId        => 'MyId',
  Type             => 'MyConstraintType',
  AcceptLanguage   => 'MyAcceptLanguage',           # OPTIONAL
  Description      => 'MyConstraintDescription',    # OPTIONAL
);

# Results:
my $ConstraintDetail     = $CreateConstraintOutput->ConstraintDetail;
my $ConstraintParameters = $CreateConstraintOutput->ConstraintParameters;
my $Status               = $CreateConstraintOutput->Status;

# Returns a L<Paws::ServiceCatalog::CreateConstraintOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/servicecatalog/CreateConstraint

ATTRIBUTES

AcceptLanguage => Str

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Description => Str

The description of the constraint.

REQUIRED IdempotencyToken => Str

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.

REQUIRED Parameters => Str

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 (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html).

REQUIRED PortfolioId => Str

The portfolio identifier.

REQUIRED ProductId => Str

The product identifier.

REQUIRED Type => Str

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateConstraint in Paws::ServiceCatalog

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues