aws-native logo
AWS Native v0.49.0, Jan 26 23

aws-native.iam.getRole

Resource Type definition for AWS::IAM::Role

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.

RoleName string

A name for the IAM role, up to 64 characters in length.

roleName String

A name for the IAM role, up to 64 characters in length.

roleName string

A name for the IAM role, up to 64 characters in length.

role_name str

A name for the IAM role, up to 64 characters in length.

roleName String

A name for the IAM role, up to 64 characters in length.

getRole Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) for the role.

AssumeRolePolicyDocument object

The trust policy that is associated with this role.

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.

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 maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

PermissionsBoundary string

The ARN of the policy used to set the permissions boundary for the role.

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

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

RoleId string

The stable and unique string identifying the role.

Tags List<Pulumi.AwsNative.IAM.Outputs.RoleTag>

A list of tags that are attached to the role.

Arn string

The Amazon Resource Name (ARN) for the role.

AssumeRolePolicyDocument interface{}

The trust policy that is associated with this role.

Description string

A description of the role that you provide.

ManagedPolicyArns []string

A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.

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 maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

PermissionsBoundary string

The ARN of the policy used to set the permissions boundary for the role.

Policies []RolePolicy

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

RoleId string

The stable and unique string identifying the role.

Tags []RoleTag

A list of tags that are attached to the role.

arn String

The Amazon Resource Name (ARN) for the role.

assumeRolePolicyDocument Object

The trust policy that is associated with this role.

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.

maxSessionDuration Integer

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 maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

permissionsBoundary String

The ARN of the policy used to set the permissions boundary for the role.

policies List<RolePolicy>

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

roleId String

The stable and unique string identifying the role.

tags List<RoleTag>

A list of tags that are attached to the role.

arn string

The Amazon Resource Name (ARN) for the role.

assumeRolePolicyDocument any

The trust policy that is associated with this role.

description string

A description of the role that you provide.

managedPolicyArns string[]

A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.

maxSessionDuration number

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 maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

permissionsBoundary string

The ARN of the policy used to set the permissions boundary for the role.

policies RolePolicy[]

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

roleId string

The stable and unique string identifying the role.

tags RoleTag[]

A list of tags that are attached to the role.

arn str

The Amazon Resource Name (ARN) for the role.

assume_role_policy_document Any

The trust policy that is associated with this role.

description str

A description of the role that you provide.

managed_policy_arns Sequence[str]

A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.

max_session_duration 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 maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

permissions_boundary str

The ARN of the policy used to set the permissions boundary for the role.

policies Sequence[RolePolicy]

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

role_id str

The stable and unique string identifying the role.

tags Sequence[RoleTag]

A list of tags that are attached to the role.

arn String

The Amazon Resource Name (ARN) for the role.

assumeRolePolicyDocument Any

The trust policy that is associated with this role.

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.

maxSessionDuration Number

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 maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

permissionsBoundary String

The ARN of the policy used to set the permissions boundary for the role.

policies List<Property Map>

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

roleId String

The stable and unique string identifying the role.

tags List<Property Map>

A list of tags that are attached to the role.

Supporting Types

RolePolicy

PolicyDocument string

The policy document.

PolicyName string

The friendly name (not ARN) identifying the policy.

PolicyDocument string

The policy document.

PolicyName string

The friendly name (not ARN) identifying the policy.

policyDocument String

The policy document.

policyName String

The friendly name (not ARN) identifying the policy.

policyDocument string

The policy document.

policyName string

The friendly name (not ARN) identifying the policy.

policy_document str

The policy document.

policy_name str

The friendly name (not ARN) identifying the policy.

policyDocument String

The policy document.

policyName String

The friendly name (not ARN) identifying the policy.

RoleTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

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