CfnLaunchRoleConstraintProps

class aws_cdk.aws_servicecatalog.CfnLaunchRoleConstraintProps(*, portfolio_id, product_id, accept_language=None, description=None, local_role_name=None, role_arn=None)

Bases: object

Properties for defining a CfnLaunchRoleConstraint.

Parameters
  • portfolio_id (str) – The portfolio identifier.

  • product_id (str) – The product identifier.

  • accept_language (Optional[str]) – The language code. - en - English (default) - jp - Japanese - zh - Chinese

  • description (Optional[str]) – The description of the constraint.

  • local_role_name (Optional[str]) – You are required to specify either the RoleArn or the LocalRoleName but can’t use both. 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.

  • role_arn (Optional[str]) – The ARN of the launch role. You are required to specify RoleArn or LocalRoleName but can’t use both.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_servicecatalog as servicecatalog

cfn_launch_role_constraint_props = servicecatalog.CfnLaunchRoleConstraintProps(
    portfolio_id="portfolioId",
    product_id="productId",

    # the properties below are optional
    accept_language="acceptLanguage",
    description="description",
    local_role_name="localRoleName",
    role_arn="roleArn"
)

Attributes

accept_language

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-acceptlanguage

Return type

Optional[str]

description

The description of the constraint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-description

Return type

Optional[str]

local_role_name

You are required to specify either the RoleArn or the LocalRoleName but can’t use both.

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-localrolename

Return type

Optional[str]

portfolio_id

The portfolio identifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-portfolioid

Return type

str

product_id

The product identifier.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-productid

Return type

str

role_arn

The ARN of the launch role.

You are required to specify RoleArn or LocalRoleName but can’t use both.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-rolearn

Return type

Optional[str]