role_arn

Specifies the Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations requested using this profile.

Details

Default value: None. You must specify this value explicitly.

Valid values: The value must be the ARN of an IAM role. See the example in the following table.

In addition, you must also specify one of the following settings:

• source_profile – To identify another profile to use to find credentials that have permission to assume the role in this profile.

• credential_source – To use either credentials identified by the current environment variables or credentials attached to an Amazon EC2 instance profile or an Amazon ECS container instance.

Ways to set this value

Location	Supported	Example
config file	Yes	role_arn = arn:aws:iam::123456789012:role/my-role-name source_profile = profile-with-user-that-can-assume-role role_arn = arn:aws:iam::123456789012:role/my-role-name credential_source = Ec2InstanceMetadata
credentials file	-
Environment variable	-
CLI parameter	-

Compatibility with AWS SDKS and tools

SDK or tool	Supported	Notes or more information
AWS Command Line Interface (AWS CLI)	X
AWS SDK for .NET	X
AWS SDK for PHP	X
AWS SDK for Python (Boto3)	X
AWS Toolkit for JetBrains consists of: AWS Toolkit for IntelliJ AWS Toolkit for PyCharm AWS Toolkit for WebStorm AWS Toolkit for Rider	X
AWS Toolkit for Visual Studio	X
AWS Toolkit for Visual Studio Code	X
AWS Tools for PowerShell	X