User L2 construct
Define a new IAM user.
Example
const user = new iam.User(this, 'MyUser');
declare const definition: sfn.IChainable;
const stateMachine = new sfn.StateMachine(this, 'StateMachine', {
definitionBody: sfn.DefinitionBody.fromChainable(definition),
});
//give user permission to send task success to the state machine
stateMachine.grant(user, 'states:SendTaskSuccess');
# definition: sfn.IChainable
user = iam.User(self, "MyUser")
state_machine = sfn.StateMachine(self, "StateMachine",
definition_body=sfn.DefinitionBody.from_chainable(definition)
)
# give user permission to send task success to the state machine
state_machine.grant(user, "states:SendTaskSuccess")
IChainable definition;
User user = new User(this, "MyUser");
StateMachine stateMachine = StateMachine.Builder.create(this, "StateMachine")
.definitionBody(DefinitionBody.fromChainable(definition))
.build();
//give user permission to send task success to the state machine
stateMachine.grant(user, "states:SendTaskSuccess");
// Install: dotnet add package Amazon.CDK.Lib
IChainable definition;
var user = new User(this, "MyUser");
var stateMachine = new StateMachine(this, "StateMachine", new StateMachineProps {
DefinitionBody = DefinitionBody.FromChainable(definition)
});
//give user permission to send task success to the state machine
stateMachine.Grant(user, "states:SendTaskSuccess");
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var definition IChainable
user := iam.NewUser(this, jsii.String("MyUser"))
stateMachine := sfn.NewStateMachine(this, jsii.String("StateMachine"), &StateMachineProps{
DefinitionBody: sfn.DefinitionBody_FromChainable(definition),
})
//give user permission to send task success to the state machine
stateMachine.grant(user, jsii.String("states:SendTaskSuccess"))
Initializer
Construct Props
groupsoptionalIGroup[]groupsoptionaltyping.List[IGroup]groupsoptionalList<IGroup>GroupsoptionalIGroup[]Groupsoptional*[]IGroup#Default: No groups.
You can also use addToGroup to add this user to a group.
managedPoliciesoptionalIManagedPolicy[]managed_policiesoptionaltyping.List[IManagedPolicy]managedPoliciesoptionalList<IManagedPolicy>ManagedPoliciesoptionalIManagedPolicy[]ManagedPoliciesoptional*[]IManagedPolicy#Default: No managed policies.
You can add managed policies later using addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)).
passwordoptionalSecretValuepasswordoptionalSecretValuepasswordoptionalSecretValuePasswordoptionalSecretValuePasswordoptionalSecretValue#Default: User won't be able to access the management console without a password.
You can use SecretValue.unsafePlainText to specify a password in plain text or use secretsmanager.Secret.fromSecretAttributes to reference a secret in Secrets Manager.
passwordResetRequiredoptionalbooleanpassword_reset_requiredoptionalboolpasswordResetRequiredoptionalBooleanPasswordResetRequiredoptionalboolPasswordResetRequiredoptional*bool= false#If this is set to 'true', you must also specify "initialPassword".
For more information about paths, see IAM Identifiers in the IAM User Guide.
permissionsBoundaryoptionalIManagedPolicypermissions_boundaryoptionalIManagedPolicypermissionsBoundaryoptionalIManagedPolicyPermissionsBoundaryoptionalIManagedPolicyPermissionsBoundaryoptionalIManagedPolicy#Default: No permissions boundary.
notes
A permissions boundary is an advanced feature for using a managed policy to set the maximum permissions that an identity-based policy can grant to an IAM entity. An entity's permissions boundary allows it to perform only the actions that are allowed by both its identity-based policies and its permissions boundaries.
userNameoptionalstringuser_nameoptionalstruserNameoptionalStringUserNameoptionalstringUserNameoptional*string#Default: Generated by CloudFormation (recommended)
notes
For valid values, see the UserName parameter for the CreateUser action in the IAM API Reference. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the user name.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Properties
assumeRoleActionstringassume_role_actionstrassumeRoleActionStringAssumeRoleActionstringAssumeRoleAction*stringrequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#permissionsBoundarymay be undefinedIManagedPolicypermissions_boundarymay be undefinedIManagedPolicypermissionsBoundarymay be undefinedIManagedPolicyPermissionsBoundarymay be undefinedIManagedPolicyPermissionsBoundarymay be undefinedIManagedPolicy#policyFragmentPrincipalPolicyFragmentpolicy_fragmentPrincipalPolicyFragmentpolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragmentrequired#principalAccountmay be undefinedstringprincipal_accountmay be undefinedstrprincipalAccountmay be undefinedStringPrincipalAccountmay be undefinedstringPrincipalAccountmay be undefined*string#Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#userRefUserReferenceuser_refUserReferenceuserRefUserReferenceUserRefUserReferenceUserRefUserReferencerequired#Methods
addManagedPolicy(policy: IManagedPolicy): voiddef add_managed_policy(self, policy: IManagedPolicy) -> Nonepublic void addManagedPolicy(IManagedPolicy policy)public void AddManagedPolicy(IManagedPolicy policy)func AddManagedPolicy(Policy IManagedPolicy)#1 parameter
Parameters
policypolicypolicypolicyPolicy— The managed policy to attach.
addToGroup(group: IGroup): voiddef add_to_group(self, group: IGroup) -> Nonepublic void addToGroup(IGroup group)public void AddToGroup(IGroup group)func AddToGroup(Group IGroup)#addToPolicy(statement: PolicyStatement): booleandef add_to_policy(self, statement: PolicyStatement) -> boolpublic Boolean addToPolicy(PolicyStatement statement)public bool AddToPolicy(PolicyStatement statement)func AddToPolicy(Statement PolicyStatement) *bool#addToPrincipalPolicy(statement: PolicyStatement): AddToPrincipalPolicyResultdef add_to_principal_policy(self, statement: PolicyStatement) -> AddToPrincipalPolicyResultpublic AddToPrincipalPolicyResult addToPrincipalPolicy(PolicyStatement statement)public AddToPrincipalPolicyResult AddToPrincipalPolicy(PolicyStatement statement)func AddToPrincipalPolicy(Statement PolicyStatement) AddToPrincipalPolicyResult#returns
Returns: true
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
attachInlinePolicy(policy: Policy): voiddef attach_inline_policy(self, policy: Policy) -> Nonepublic void attachInlinePolicy(Policy policy)public void AttachInlinePolicy(Policy policy)func AttachInlinePolicy(Policy Policy)#fromUserArn(scope: Construct, id: string, userArn: string): IUser@staticmethod def from_user_arn(scope: Construct, id: str, user_arn: str) -> IUserpublic static IUser fromUserArn(Construct scope, String id, String userArn)public static IUser FromUserArn(Construct scope, string id, string userArn)func FromUserArn(Scope Construct, Id *string, UserArn *string) IUserstatic#If the ARN comes from a Token, the User cannot have a path; if so, any attempt to reference its username will fail.
3 parameters
Parameters
scopescopescopescopeScope— construct scope.ididididId— construct id.userArnuser_arnuserArnuserArnUserArn— the ARN of an existing user to import.
fromUserAttributes(scope: Construct, id: string, attrs: UserAttributes): IUser@staticmethod def from_user_attributes(scope: Construct, id: str, attrs: UserAttributes) -> IUserpublic static IUser fromUserAttributes(Construct scope, String id, UserAttributes attrs)public static IUser FromUserAttributes(Construct scope, string id, UserAttributes attrs)func FromUserAttributes(Scope Construct, Id *string, Attrs UserAttributes) IUserstatic#If the ARN comes from a Token, the User cannot have a path; if so, any attempt to reference its username will fail.
3 parameters
Parameters
scopescopescopescopeScope— construct scope.ididididId— construct id.attrsattrsattrsattrsAttrs— the attributes of the user to import.
fromUserName(scope: Construct, id: string, userName: string): IUser@staticmethod def from_user_name(scope: Construct, id: str, user_name: str) -> IUserpublic static IUser fromUserName(Construct scope, String id, String userName)public static IUser FromUserName(Construct scope, string id, string userName)func FromUserName(Scope Construct, Id *string, UserName *string) IUserstatic#3 parameters
Parameters
scopescopescopescopeScope— construct scope.ididididId— construct id.userNameuser_nameuserNameuserNameUserName— the username of the existing user to import.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.