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:
- Role
Name string A name for the IAM role, up to 64 characters in length.
- Role
Name string A name for the IAM role, up to 64 characters in length.
- role
Name String A name for the IAM role, up to 64 characters in length.
- role
Name 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.
- role
Name 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.
- Assume
Role objectPolicy Document The trust policy that is associated with this role.
- Description string
A description of the role that you provide.
- Managed
Policy List<string>Arns A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
- Max
Session intDuration 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 string The ARN of the policy used to set the permissions boundary for the role.
- Policies
List<Pulumi.
Aws Native. IAM. Outputs. Role Policy> Adds or updates an inline policy document that is embedded in the specified IAM role.
- Role
Id string The stable and unique string identifying the role.
- List<Pulumi.
Aws Native. IAM. Outputs. Role Tag> A list of tags that are attached to the role.
- Arn string
The Amazon Resource Name (ARN) for the role.
- Assume
Role interface{}Policy Document The trust policy that is associated with this role.
- Description string
A description of the role that you provide.
- Managed
Policy []stringArns A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
- Max
Session intDuration 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 string The ARN of the policy used to set the permissions boundary for the role.
- Policies
[]Role
Policy Adds or updates an inline policy document that is embedded in the specified IAM role.
- Role
Id string The stable and unique string identifying the role.
- []Role
Tag A list of tags that are attached to the role.
- arn String
The Amazon Resource Name (ARN) for the role.
- assume
Role ObjectPolicy Document The trust policy that is associated with this role.
- description String
A description of the role that you provide.
- managed
Policy List<String>Arns A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
- max
Session IntegerDuration 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 String The ARN of the policy used to set the permissions boundary for the role.
- policies
List<Role
Policy> Adds or updates an inline policy document that is embedded in the specified IAM role.
- role
Id String The stable and unique string identifying the role.
- List<Role
Tag> A list of tags that are attached to the role.
- arn string
The Amazon Resource Name (ARN) for the role.
- assume
Role anyPolicy Document The trust policy that is associated with this role.
- description string
A description of the role that you provide.
- managed
Policy string[]Arns A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
- max
Session numberDuration 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 string The ARN of the policy used to set the permissions boundary for the role.
- policies
Role
Policy[] Adds or updates an inline policy document that is embedded in the specified IAM role.
- role
Id string The stable and unique string identifying the role.
- Role
Tag[] A list of tags that are attached to the role.
- arn str
The Amazon Resource Name (ARN) for the role.
- assume_
role_ Anypolicy_ document The trust policy that is associated with this role.
- description str
A description of the role that you provide.
- managed_
policy_ Sequence[str]arns A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
- max_
session_ intduration 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[Role
Policy] 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.
- Sequence[Role
Tag] A list of tags that are attached to the role.
- arn String
The Amazon Resource Name (ARN) for the role.
- assume
Role AnyPolicy Document The trust policy that is associated with this role.
- description String
A description of the role that you provide.
- managed
Policy List<String>Arns A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
- max
Session NumberDuration 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 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.
- role
Id String The stable and unique string identifying the role.
- List<Property Map>
A list of tags that are attached to the role.
Supporting Types
RolePolicy
- Policy
Document string The policy document.
- Policy
Name string The friendly name (not ARN) identifying the policy.
- Policy
Document string The policy document.
- Policy
Name string The friendly name (not ARN) identifying the policy.
- policy
Document String The policy document.
- policy
Name String The friendly name (not ARN) identifying the policy.
- policy
Document string The policy document.
- policy
Name 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.
- policy
Document String The policy document.
- policy
Name 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