Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. sso
  5. getPermissionSet

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.sso.getPermissionSet

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for SSO PermissionSet

    Using getPermissionSet

    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 getPermissionSet(args: GetPermissionSetArgs, opts?: InvokeOptions): Promise<GetPermissionSetResult>
function getPermissionSetOutput(args: GetPermissionSetOutputArgs, opts?: InvokeOptions): Output<GetPermissionSetResult>
    def get_permission_set(instance_arn: Optional[str] = None,
                       permission_set_arn: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPermissionSetResult
def get_permission_set_output(instance_arn: Optional[pulumi.Input[str]] = None,
                       permission_set_arn: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPermissionSetResult]
    func LookupPermissionSet(ctx *Context, args *LookupPermissionSetArgs, opts ...InvokeOption) (*LookupPermissionSetResult, error)
func LookupPermissionSetOutput(ctx *Context, args *LookupPermissionSetOutputArgs, opts ...InvokeOption) LookupPermissionSetResultOutput

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

    public static class GetPermissionSet 
{
    public static Task<GetPermissionSetResult> InvokeAsync(GetPermissionSetArgs args, InvokeOptions? opts = null)
    public static Output<GetPermissionSetResult> Invoke(GetPermissionSetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPermissionSetResult> getPermissionSet(GetPermissionSetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:sso:getPermissionSet
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceArn string
    The sso instance arn that the permission set is owned.
    PermissionSetArn string
    The permission set that the policy will be attached to
    InstanceArn string
    The sso instance arn that the permission set is owned.
    PermissionSetArn string
    The permission set that the policy will be attached to
    instanceArn String
    The sso instance arn that the permission set is owned.
    permissionSetArn String
    The permission set that the policy will be attached to
    instanceArn string
    The sso instance arn that the permission set is owned.
    permissionSetArn string
    The permission set that the policy will be attached to
    instance_arn str
    The sso instance arn that the permission set is owned.
    permission_set_arn str
    The permission set that the policy will be attached to
    instanceArn String
    The sso instance arn that the permission set is owned.
    permissionSetArn String
    The permission set that the policy will be attached to

    getPermissionSet Result

    The following output properties are available:

    CustomerManagedPolicyReferences List<Pulumi.AwsNative.Sso.Outputs.PermissionSetCustomerManagedPolicyReference>
    Specifies the names and paths of the customer managed policies that you have attached to your permission set.
    Description string
    The permission set description.
    InlinePolicy object

    The inline policy to put in permission set.

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

    ManagedPolicies List<string>
    A structure that stores the details of the AWS managed policy.
    PermissionSetArn string
    The permission set that the policy will be attached to
    PermissionsBoundary Pulumi.AwsNative.Sso.Outputs.PermissionSetPermissionsBoundary

    Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide .

    Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide .

    RelayStateType string
    The relay state URL that redirect links to any service in the AWS Management Console.
    SessionDuration string
    The length of time that a user can be signed in to an AWS account.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags to attach to the new PermissionSet .
    CustomerManagedPolicyReferences []PermissionSetCustomerManagedPolicyReference
    Specifies the names and paths of the customer managed policies that you have attached to your permission set.
    Description string
    The permission set description.
    InlinePolicy interface{}

    The inline policy to put in permission set.

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

    ManagedPolicies []string
    A structure that stores the details of the AWS managed policy.
    PermissionSetArn string
    The permission set that the policy will be attached to
    PermissionsBoundary PermissionSetPermissionsBoundary

    Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide .

    Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide .

    RelayStateType string
    The relay state URL that redirect links to any service in the AWS Management Console.
    SessionDuration string
    The length of time that a user can be signed in to an AWS account.
    Tags Tag
    The tags to attach to the new PermissionSet .
    customerManagedPolicyReferences List<PermissionSetCustomerManagedPolicyReference>
    Specifies the names and paths of the customer managed policies that you have attached to your permission set.
    description String
    The permission set description.
    inlinePolicy Object

    The inline policy to put in permission set.

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

    managedPolicies List<String>
    A structure that stores the details of the AWS managed policy.
    permissionSetArn String
    The permission set that the policy will be attached to
    permissionsBoundary PermissionSetPermissionsBoundary

    Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide .

    Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide .

    relayStateType String
    The relay state URL that redirect links to any service in the AWS Management Console.
    sessionDuration String
    The length of time that a user can be signed in to an AWS account.
    tags List<Tag>
    The tags to attach to the new PermissionSet .
    customerManagedPolicyReferences PermissionSetCustomerManagedPolicyReference[]
    Specifies the names and paths of the customer managed policies that you have attached to your permission set.
    description string
    The permission set description.
    inlinePolicy any

    The inline policy to put in permission set.

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

    managedPolicies string[]
    A structure that stores the details of the AWS managed policy.
    permissionSetArn string
    The permission set that the policy will be attached to
    permissionsBoundary PermissionSetPermissionsBoundary

    Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide .

    Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide .

    relayStateType string
    The relay state URL that redirect links to any service in the AWS Management Console.
    sessionDuration string
    The length of time that a user can be signed in to an AWS account.
    tags Tag[]
    The tags to attach to the new PermissionSet .
    customer_managed_policy_references Sequence[PermissionSetCustomerManagedPolicyReference]
    Specifies the names and paths of the customer managed policies that you have attached to your permission set.
    description str
    The permission set description.
    inline_policy Any

    The inline policy to put in permission set.

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

    managed_policies Sequence[str]
    A structure that stores the details of the AWS managed policy.
    permission_set_arn str
    The permission set that the policy will be attached to
    permissions_boundary PermissionSetPermissionsBoundary

    Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide .

    Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide .

    relay_state_type str
    The relay state URL that redirect links to any service in the AWS Management Console.
    session_duration str
    The length of time that a user can be signed in to an AWS account.
    tags Sequence[root_Tag]
    The tags to attach to the new PermissionSet .
    customerManagedPolicyReferences List<Property Map>
    Specifies the names and paths of the customer managed policies that you have attached to your permission set.
    description String
    The permission set description.
    inlinePolicy Any

    The inline policy to put in permission set.

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

    managedPolicies List<String>
    A structure that stores the details of the AWS managed policy.
    permissionSetArn String
    The permission set that the policy will be attached to
    permissionsBoundary Property Map

    Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide .

    Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide .

    relayStateType String
    The relay state URL that redirect links to any service in the AWS Management Console.
    sessionDuration String
    The length of time that a user can be signed in to an AWS account.
    tags List<Property Map>
    The tags to attach to the new PermissionSet .

    Supporting Types

    PermissionSetCustomerManagedPolicyReference

    Name string
    The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
    Path string
    The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
    Name string
    The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
    Path string
    The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
    name String
    The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
    path String
    The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
    name string
    The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
    path string
    The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
    name str
    The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
    path str
    The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .
    name String
    The name of the IAM policy that you have configured in each account where you want to deploy your permission set.
    path String
    The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the IAM User Guide .

    PermissionSetPermissionsBoundary

    CustomerManagedPolicyReference Pulumi.AwsNative.Sso.Inputs.PermissionSetCustomerManagedPolicyReference
    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
    ManagedPolicyArn string
    The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary.
    CustomerManagedPolicyReference PermissionSetCustomerManagedPolicyReference
    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
    ManagedPolicyArn string
    The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary.
    customerManagedPolicyReference PermissionSetCustomerManagedPolicyReference
    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
    managedPolicyArn String
    The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary.
    customerManagedPolicyReference PermissionSetCustomerManagedPolicyReference
    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
    managedPolicyArn string
    The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary.
    customer_managed_policy_reference PermissionSetCustomerManagedPolicyReference
    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
    managed_policy_arn str
    The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary.
    customerManagedPolicyReference Property Map
    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
    managedPolicyArn String
    The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native