Class CfnLaunchRoleConstraint
A CloudFormation AWS::ServiceCatalog::LaunchRoleConstraint
.
Inherited Members
Namespace: Amazon.CDK.AWS.ServiceCatalog
Assembly: Amazon.CDK.AWS.ServiceCatalog.dll
Syntax (csharp)
public class CfnLaunchRoleConstraint : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnLaunchRoleConstraint
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a launch constraint.
CloudformationResource: AWS::ServiceCatalog::LaunchRoleConstraint
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ServiceCatalog;
var cfnLaunchRoleConstraint = new CfnLaunchRoleConstraint(this, "MyCfnLaunchRoleConstraint", new CfnLaunchRoleConstraintProps {
PortfolioId = "portfolioId",
ProductId = "productId",
// the properties below are optional
AcceptLanguage = "acceptLanguage",
Description = "description",
LocalRoleName = "localRoleName",
RoleArn = "roleArn"
});
Synopsis
Constructors
CfnLaunchRoleConstraint(Construct, String, ICfnLaunchRoleConstraintProps) | Create a new |
CfnLaunchRoleConstraint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnLaunchRoleConstraint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AcceptLanguage | The language code. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the constraint. |
LocalRoleName | You are required to specify either the |
PortfolioId | The portfolio identifier. |
ProductId | The product identifier. |
RoleArn | The ARN of the launch role. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnLaunchRoleConstraint(Construct, String, ICfnLaunchRoleConstraintProps)
Create a new AWS::ServiceCatalog::LaunchRoleConstraint
.
public CfnLaunchRoleConstraint(Construct scope, string id, ICfnLaunchRoleConstraintProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnLaunchRoleConstraintProps
- resource properties.
CfnLaunchRoleConstraint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnLaunchRoleConstraint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnLaunchRoleConstraint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnLaunchRoleConstraint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AcceptLanguage
The language code.
public virtual string AcceptLanguage { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the constraint.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
LocalRoleName
You are required to specify either the RoleArn
or the LocalRoleName
but can't use both.
public virtual string LocalRoleName { get; set; }
Property Value
System.String
Remarks
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.
PortfolioId
The portfolio identifier.
public virtual string PortfolioId { get; set; }
Property Value
System.String
Remarks
ProductId
The product identifier.
public virtual string ProductId { get; set; }
Property Value
System.String
Remarks
RoleArn
The ARN of the launch role.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
You are required to specify RoleArn
or LocalRoleName
but can't use both.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>