aws-cdk-lib.aws_servicecatalog.CfnLaunchRoleConstraintProps

interface CfnLaunchRoleConstraintProps

LanguageType name
.NETAmazon.CDK.AWS.Servicecatalog.CfnLaunchRoleConstraintProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsservicecatalog#CfnLaunchRoleConstraintProps
Javasoftware.amazon.awscdk.services.servicecatalog.CfnLaunchRoleConstraintProps
Pythonaws_cdk.aws_servicecatalog.CfnLaunchRoleConstraintProps
TypeScript aws-cdk-lib » aws_servicecatalog » CfnLaunchRoleConstraintProps

Properties for defining a CfnLaunchRoleConstraint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_servicecatalog as servicecatalog } from 'aws-cdk-lib';
const cfnLaunchRoleConstraintProps: servicecatalog.CfnLaunchRoleConstraintProps = {
  portfolioId: 'portfolioId',
  productId: 'productId',

  // the properties below are optional
  acceptLanguage: 'acceptLanguage',
  description: 'description',
  localRoleName: 'localRoleName',
  roleArn: 'roleArn',
};

Properties

NameTypeDescription
portfolioIdstringThe portfolio identifier.
productIdstringThe product identifier.
acceptLanguage?stringThe language code.
description?stringThe description of the constraint.
localRoleName?stringYou are required to specify either the RoleArn or the LocalRoleName but can't use both.
roleArn?stringThe ARN of the launch role.

portfolioId

Type: string

The portfolio identifier.


productId

Type: string

The product identifier.


acceptLanguage?

Type: string (optional)

The language code.

  • jp - Japanese
  • zh - Chinese

description?

Type: string (optional)

The description of the constraint.


localRoleName?

Type: string (optional)

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.


roleArn?

Type: string (optional)

The ARN of the launch role.

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