Role L2 construct
IAM Role.
Defines an IAM role. The role is created with an assume policy document associated with the specified AWS service principal defined in serviceAssumeRole.
Example
// Create a browser
const browser = new agentcore.BrowserCustom(this, "MyBrowser", {
browserCustomName: "my_browser",
description: "Browser for web automation",
networkConfiguration: agentcore.BrowserNetworkConfiguration.usingPublicNetwork(),
});
// Create a role that needs access to the browser
const userRole = new iam.Role(this, "UserRole", {
assumedBy: new iam.ServicePrincipal("lambda.amazonaws.com"),
});
// Grant read permissions (Get and List actions)
browser.grantRead(userRole);
// Grant use permissions (Start, Update, Connect to the automation stream, and Stop actions)
browser.grantUse(userRole);
// Grant specific custom permissions
browser.grant(userRole, "bedrock-agentcore:GetBrowserSession");
# Create a browser
browser = agentcore.BrowserCustom(self, "MyBrowser",
browser_custom_name="my_browser",
description="Browser for web automation",
network_configuration=agentcore.BrowserNetworkConfiguration.using_public_network()
)
# Create a role that needs access to the browser
user_role = iam.Role(self, "UserRole",
assumed_by=iam.ServicePrincipal("lambda.amazonaws.com")
)
# Grant read permissions (Get and List actions)
browser.grant_read(user_role)
# Grant use permissions (Start, Update, Connect to the automation stream, and Stop actions)
browser.grant_use(user_role)
# Grant specific custom permissions
browser.grant(user_role, "bedrock-agentcore:GetBrowserSession")
// Create a browser
BrowserCustom browser = BrowserCustom.Builder.create(this, "MyBrowser")
.browserCustomName("my_browser")
.description("Browser for web automation")
.networkConfiguration(BrowserNetworkConfiguration.usingPublicNetwork())
.build();
// Create a role that needs access to the browser
Role userRole = Role.Builder.create(this, "UserRole")
.assumedBy(new ServicePrincipal("lambda.amazonaws.com"))
.build();
// Grant read permissions (Get and List actions)
browser.grantRead(userRole);
// Grant use permissions (Start, Update, Connect to the automation stream, and Stop actions)
browser.grantUse(userRole);
// Grant specific custom permissions
browser.grant(userRole, "bedrock-agentcore:GetBrowserSession");
// Install: dotnet add package Amazon.CDK.Lib
// Create a browser
var browser = new BrowserCustom(this, "MyBrowser", new BrowserCustomProps {
BrowserCustomName = "my_browser",
Description = "Browser for web automation",
NetworkConfiguration = BrowserNetworkConfiguration.UsingPublicNetwork()
});
// Create a role that needs access to the browser
var userRole = new Role(this, "UserRole", new RoleProps {
AssumedBy = new ServicePrincipal("lambda.amazonaws.com")
});
// Grant read permissions (Get and List actions)
browser.GrantRead(userRole);
// Grant use permissions (Start, Update, Connect to the automation stream, and Stop actions)
browser.GrantUse(userRole);
// Grant specific custom permissions
browser.Grant(userRole, "bedrock-agentcore:GetBrowserSession");
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Create a browser
browser := agentcore.NewBrowserCustom(this, jsii.String("MyBrowser"), &BrowserCustomProps{
BrowserCustomName: jsii.String("my_browser"),
Description: jsii.String("Browser for web automation"),
NetworkConfiguration: agentcore.BrowserNetworkConfiguration_UsingPublicNetwork(),
})
// Create a role that needs access to the browser
userRole := iam.NewRole(this, jsii.String("UserRole"), &RoleProps{
AssumedBy: iam.NewServicePrincipal(jsii.String("lambda.amazonaws.com")),
})
// Grant read permissions (Get and List actions)
browser.GrantRead(userRole)
// Grant use permissions (Start, Update, Connect to the automation stream, and Stop actions)
browser.GrantUse(userRole)
// Grant specific custom permissions
browser.Grant(userRole, jsii.String("bedrock-agentcore:GetBrowserSession"))
Initializer
Construct Props
assumedByIPrincipalassumed_byIPrincipalassumedByIPrincipalAssumedByIPrincipalAssumedByIPrincipalrequired#You can later modify the assume role policy document by accessing it via the assumeRolePolicy property.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: No description.
It can be up to 1000 characters long.
externalIdsoptionalstring[]external_idsoptionaltyping.List[str]externalIdsoptionalList<String>ExternalIdsoptionalstring[]ExternalIdsoptional*[]*string#Default: No external ID required
If the configured and provided external IDs do not match, the AssumeRole operation will fail.
inlinePoliciesoptional{ [key: string]: PolicyDocument }inline_policiesoptionaltyping.Mapping[str, PolicyDocument]inlinePoliciesoptionalMap<String, PolicyDocument>InlinePoliciesoptionalIDictionary<string, PolicyDocument>InlinePoliciesoptional*map[string]PolicyDocument#Default: No policy is inlined in the Role resource.
These policies will be created with the role, whereas those added by addToPolicy are added using a separate CloudFormation resource (allowing a way around circular dependencies that could otherwise be introduced).
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)).
maxSessionDurationoptionalDurationmax_session_durationoptionalDurationmaxSessionDurationoptionalDurationMaxSessionDurationoptionalDurationMaxSessionDurationoptionalDuration= Duration.hours(1)#notes
This setting can have a value from 1 hour (3600sec) to 12 (43200sec) hours.
Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter.
If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL.
For information about IAM paths, see Friendly Names and Paths in 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.
roleNameoptionalstringrole_nameoptionalstrroleNameoptionalStringRoleNameoptionalstringRoleNameoptional*string#Default: AWS CloudFormation generates a unique physical ID and uses that ID for the role name.
notes
For valid values, see the RoleName parameter for the CreateRole action in the IAM API Reference.
IMPORTANT: 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*string#assumeRolePolicymay be undefinedPolicyDocumentassume_role_policymay be undefinedPolicyDocumentassumeRolePolicymay be undefinedPolicyDocumentAssumeRolePolicymay be undefinedPolicyDocumentAssumeRolePolicymay be undefinedPolicyDocument#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#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_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#permissionsBoundarymay be undefinedIManagedPolicypermissions_boundarymay be undefinedIManagedPolicypermissionsBoundarymay be undefinedIManagedPolicyPermissionsBoundarymay be undefinedIManagedPolicyPermissionsBoundarymay be undefinedIManagedPolicy#policyFragmentPrincipalPolicyFragmentpolicy_fragmentPrincipalPolicyFragmentpolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragmentPolicyFragmentPrincipalPolicyFragment#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*stringstatic#For example, AIDAJQABLZS4A3QDU576Q.
roleRefRoleReferencerole_refRoleReferenceroleRefRoleReferenceRoleRefRoleReferenceRoleRefRoleReference#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 the managed policy to attach.
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#If there is no default policy attached to this role, it will be created.
1 parameter
Parameters
statementstatementstatementstatementStatement— The permission statement to add to the policy document.
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)#Because in this case, this construct does not have a CfnResource in the tree.
1 parameter
Parameters
policypolicypolicypolicyPolicy— RemovalPolicy.
attachInlinePolicy(policy: Policy): voiddef attach_inline_policy(self, policy: Policy) -> Nonepublic void attachInlinePolicy(Policy policy)public void AttachInlinePolicy(Policy policy)func AttachInlinePolicy(Policy Policy)#1 parameter
Parameters
policypolicypolicypolicyPolicy— The policy to attach.
customizeRoles(scope: Construct, options?: CustomizeRolesOptions): void@staticmethod def customize_roles(scope: Construct, options: typing.Optional[CustomizeRolesOptions] = None) -> Nonepublic static void customizeRoles(Construct scope, CustomizeRolesOptions options)public static void CustomizeRoles(Construct scope, CustomizeRolesOptions? options = null)func CustomizeRoles(Scope Construct, Options CustomizeRolesOptions)static#notes · 2 parameters · example
It is recommended that you do not use this method and instead allow CDK to manage role creation. This should only be used in environments where CDK applications are not allowed to created IAM roles.
This can be used to prevent the CDK application from creating roles within the given scope and instead replace the references to the roles with precreated role names. A report will be synthesized in the cloud assembly (i.e. cdk.out) that will contain the list of IAM roles that would have been created along with the IAM policy statements that the role should contain. This report can then be used to create the IAM roles outside of CDK and then the created role names can be provided in usePrecreatedRoles.
Parameters
scopescopescopescopeScope— construct scope to customize role creation.optionsoptionsoptionsoptionsOptions— options for configuring role creation.
declare const app: App;
iam.Role.customizeRoles(app, {
usePrecreatedRoles: {
'ConstructPath/To/Role': 'my-precreated-role-name',
},
});
fromLookup(scope: Construct, id: string, options: RoleLookupOptions): IRole@staticmethod def from_lookup(scope: Construct, id: str, options: RoleLookupOptions) -> IRolepublic static IRole fromLookup(Construct scope, String id, RoleLookupOptions options)public static IRole FromLookup(Construct scope, string id, RoleLookupOptions options)func FromLookup(Scope Construct, Id *string, Options RoleLookupOptions) IRolestatic#fromRoleArn(scope: Construct, id: string, roleArn: string, options?: FromRoleArnOptions): IRole@staticmethod def from_role_arn(scope: Construct, id: str, role_arn: str, options: typing.Optional[FromRoleArnOptions] = None) -> IRolepublic static IRole fromRoleArn(Construct scope, String id, String roleArn, FromRoleArnOptions options)public static IRole FromRoleArn(Construct scope, string id, string roleArn, FromRoleArnOptions? options = null)func FromRoleArn(Scope Construct, Id *string, RoleArn *string, Options FromRoleArnOptions) IRolestatic#notes · 4 parameters
If the imported Role ARN is a Token (such as a CfnParameter.valueAsString or a Fn.importValue()) and the referenced role has a path (like arn:...:role/AdminRoles/Alice), the roleName property will not resolve to the correct value. Instead it will resolve to the first path component. We unfortunately cannot express the correct calculation of the full path name as a CloudFormation expression. In this scenario the Role ARN should be supplied without the path in order to resolve the correct role resource.
Parameters
scopescopescopescopeScope— construct scope.ididididId— construct id.roleArnrole_arnroleArnroleArnRoleArn— the ARN of the role to import.optionsoptionsoptionsoptionsOptions— allow customizing the behavior of the returned role.
fromRoleName(scope: Construct, id: string, roleName: string, options?: FromRoleNameOptions): IRole@staticmethod def from_role_name(scope: Construct, id: str, role_name: str, options: typing.Optional[FromRoleNameOptions] = None) -> IRolepublic static IRole fromRoleName(Construct scope, String id, String roleName, FromRoleNameOptions options)public static IRole FromRoleName(Construct scope, string id, string roleName, FromRoleNameOptions? options = null)func FromRoleName(Scope Construct, Id *string, RoleName *string, Options FromRoleNameOptions) IRolestatic#The imported role is assumed to exist in the same account as the account the scope's containing Stack is being deployed to.
4 parameters
Parameters
scopescopescopescopeScope— construct scope.ididididId— construct id.roleNamerole_nameroleNameroleNameRoleName— the name of the role to import.optionsoptionsoptionsoptionsOptions— allow customizing the behavior of the returned role.
grant(grantee: IPrincipal, ...actions: string[]): Grantdef grant(self, grantee: IPrincipal, actions: str) -> Grantpublic Grant grant(IPrincipal grantee, String actions)public Grant Grant(IPrincipal grantee, string actions)func Grant(Grantee IPrincipal, Actions *string) Grant#grantAssumeRole(identity: IPrincipal): Grantdef grant_assume_role(self, identity: IPrincipal) -> Grantpublic Grant grantAssumeRole(IPrincipal identity)public Grant GrantAssumeRole(IPrincipal identity)func GrantAssumeRole(Identity IPrincipal) Grant#grantPassRole(identity: IPrincipal): Grantdef grant_pass_role(self, identity: IPrincipal) -> Grantpublic Grant grantPassRole(IPrincipal identity)public Grant GrantPassRole(IPrincipal identity)func GrantPassRole(Identity IPrincipal) Grant#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#isRole(x: any): boolean@staticmethod def is_role(x: Any) -> boolpublic static Boolean isRole(Object x)public static bool IsRole(object x)func IsRole(X interface{}) *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.
withoutPolicyUpdates(options?: WithoutPolicyUpdatesOptions): IRoledef without_policy_updates(self, options: typing.Optional[WithoutPolicyUpdatesOptions] = None) -> IRolepublic IRole withoutPolicyUpdates(WithoutPolicyUpdatesOptions options)public IRole WithoutPolicyUpdates(WithoutPolicyUpdatesOptions? options = null)func WithoutPolicyUpdates(Options WithoutPolicyUpdatesOptions) IRole#Use the object returned by this method if you want this Role to be used by a construct without it automatically updating the Role's Policies.
If you do, you are responsible for adding the correct statements to the Role's policies yourself.