AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iam.getRole

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getRole

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRole(args: GetRoleArgs, opts?: InvokeOptions): Promise<GetRoleResult>
function getRoleOutput(args: GetRoleOutputArgs, opts?: InvokeOptions): Output<GetRoleResult>

def get_role(role_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRoleResult
def get_role_output(role_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRoleResult]

func LookupRole(ctx *Context, args *LookupRoleArgs, opts ...InvokeOption) (*LookupRoleResult, error)
func LookupRoleOutput(ctx *Context, args *LookupRoleOutputArgs, opts ...InvokeOption) LookupRoleResultOutput

> Note: This function is named LookupRole in the Go SDK.

public static class GetRole 
{
    public static Task<GetRoleResult> InvokeAsync(GetRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetRoleResult> Invoke(GetRoleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:iam:getRole
  arguments:
    # arguments dictionary

The following arguments are supported:

RoleName string

A name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the CreateRole action in the IAM User Guide .

This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1".

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role 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 .

Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

RoleName string

A name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the CreateRole action in the IAM User Guide .

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role name.

Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

roleName String

A name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the CreateRole action in the IAM User Guide .

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role name.

Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

roleName string

A name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the CreateRole action in the IAM User Guide .

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role name.

Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

role_name str

A name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the CreateRole action in the IAM User Guide .

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role name.

Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

roleName String

A name for the IAM role, up to 64 characters in length. For valid values, see the RoleName parameter for the CreateRole action in the IAM User Guide .

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role name.

Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

getRole Result

The following output properties are available:

Arn string

Returns the Amazon Resource Name (ARN) for the role. For example:

{"Fn::GetAtt" : ["MyRole", "Arn"] }

This will return a value such as arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF .

AssumeRolePolicyDocument object

The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see Template Examples. For more information about the elements that you can use in an IAM policy, see Policy Elements Reference in the User Guide.

Search the CloudFormation User Guide for AWS::IAM::Role for more information about the expected schema for this property.

Description string

A description of the role that you provide.

ManagedPolicyArns List<string>

A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. For more information about ARNs, see Amazon Resource Names (ARNs) and Service Namespaces in the General Reference.

MaxSessionDuration int

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the 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 more information, see Using IAM roles in the IAM User Guide.

PermissionsBoundary string

The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

Policies List<Pulumi.AwsNative.Iam.Outputs.RolePolicy>

Adds or updates an inline policy document that is embedded in the specified IAM role.

When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities .

A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .

If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

RoleId string

Returns the stable and unique string identifying the role. For example, AIDAJQABLZS4A3QDU576Q .

For more information about IDs, see IAM Identifiers in the IAM User Guide .

Tags List<Pulumi.AwsNative.Outputs.Tag>

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Arn string

Returns the Amazon Resource Name (ARN) for the role. For example:

{"Fn::GetAtt" : ["MyRole", "Arn"] }

This will return a value such as arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF .

AssumeRolePolicyDocument interface{}

Search the CloudFormation User Guide for AWS::IAM::Role for more information about the expected schema for this property.

Description string

A description of the role that you provide.

ManagedPolicyArns []string

MaxSessionDuration int

PermissionsBoundary string

The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

Policies []RolePolicyType

Adds or updates an inline policy document that is embedded in the specified IAM role.

A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .

If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

RoleId string

Returns the stable and unique string identifying the role. For example, AIDAJQABLZS4A3QDU576Q .

For more information about IDs, see IAM Identifiers in the IAM User Guide .

Tags Tag

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

arn String

Returns the Amazon Resource Name (ARN) for the role. For example:

{"Fn::GetAtt" : ["MyRole", "Arn"] }

This will return a value such as arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF .

assumeRolePolicyDocument Object

Search the CloudFormation User Guide for AWS::IAM::Role for more information about the expected schema for this property.

description String

A description of the role that you provide.

managedPolicyArns List<String>

maxSessionDuration Integer

permissionsBoundary String

The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

policies List<RolePolicy>

Adds or updates an inline policy document that is embedded in the specified IAM role.

A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .

If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

roleId String

Returns the stable and unique string identifying the role. For example, AIDAJQABLZS4A3QDU576Q .

For more information about IDs, see IAM Identifiers in the IAM User Guide .

tags List<Tag>

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

arn string

Returns the Amazon Resource Name (ARN) for the role. For example:

{"Fn::GetAtt" : ["MyRole", "Arn"] }

This will return a value such as arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF .

assumeRolePolicyDocument any

Search the CloudFormation User Guide for AWS::IAM::Role for more information about the expected schema for this property.

description string

A description of the role that you provide.

managedPolicyArns string[]

maxSessionDuration number

permissionsBoundary string

The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

policies RolePolicy[]

Adds or updates an inline policy document that is embedded in the specified IAM role.

A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .

If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

roleId string

Returns the stable and unique string identifying the role. For example, AIDAJQABLZS4A3QDU576Q .

For more information about IDs, see IAM Identifiers in the IAM User Guide .

tags Tag[]

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

arn str

Returns the Amazon Resource Name (ARN) for the role. For example:

{"Fn::GetAtt" : ["MyRole", "Arn"] }

This will return a value such as arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF .

assume_role_policy_document Any

Search the CloudFormation User Guide for AWS::IAM::Role for more information about the expected schema for this property.

description str

A description of the role that you provide.

managed_policy_arns Sequence[str]

max_session_duration int

permissions_boundary str

The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

policies Sequence[RolePolicy]

Adds or updates an inline policy document that is embedded in the specified IAM role.

A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .

If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

role_id str

Returns the stable and unique string identifying the role. For example, AIDAJQABLZS4A3QDU576Q .

For more information about IDs, see IAM Identifiers in the IAM User Guide .

tags Sequence[root_Tag]

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

arn String

Returns the Amazon Resource Name (ARN) for the role. For example:

{"Fn::GetAtt" : ["MyRole", "Arn"] }

This will return a value such as arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF .

assumeRolePolicyDocument Any

Search the CloudFormation User Guide for AWS::IAM::Role for more information about the expected schema for this property.

description String

A description of the role that you provide.

managedPolicyArns List<String>

maxSessionDuration Number

permissionsBoundary String

The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

policies List<Property Map>

Adds or updates an inline policy document that is embedded in the specified IAM role.

A role can also have an attached managed policy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .

If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

roleId String

Returns the stable and unique string identifying the role. For example, AIDAJQABLZS4A3QDU576Q .

For more information about IDs, see IAM Identifiers in the IAM User Guide .

tags List<Property Map>

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Supporting Types

RolePolicy

PolicyDocument object: The entire contents of the policy that defines permissions. For more information, see Overview of JSON policies.
PolicyName string: The friendly name (not ARN) identifying the policy.

PolicyDocument interface{}: The entire contents of the policy that defines permissions. For more information, see Overview of JSON policies.
PolicyName string: The friendly name (not ARN) identifying the policy.

policyDocument Object: The entire contents of the policy that defines permissions. For more information, see Overview of JSON policies.
policyName String: The friendly name (not ARN) identifying the policy.

policyDocument any: The entire contents of the policy that defines permissions. For more information, see Overview of JSON policies.
policyName string: The friendly name (not ARN) identifying the policy.

policy_document Any: The entire contents of the policy that defines permissions. For more information, see Overview of JSON policies.
policy_name str: The friendly name (not ARN) identifying the policy.

policyDocument Any: The entire contents of the policy that defines permissions. For more information, see Overview of JSON policies.
policyName String: The friendly name (not ARN) identifying the policy.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iam.getRole

On this page

On this page

Using getRole

getRole Result

Supporting Types

RolePolicy

Tag

Package Details

On this page

On this page