1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. appstream
  5. getEntitlement

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

AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi

aws-native.appstream.getEntitlement

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi

    Resource Type definition for AWS::AppStream::Entitlement

    Using getEntitlement

    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 getEntitlement(args: GetEntitlementArgs, opts?: InvokeOptions): Promise<GetEntitlementResult>
    function getEntitlementOutput(args: GetEntitlementOutputArgs, opts?: InvokeOptions): Output<GetEntitlementResult>
    def get_entitlement(name: Optional[str] = None,
                        stack_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEntitlementResult
    def get_entitlement_output(name: Optional[pulumi.Input[str]] = None,
                        stack_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEntitlementResult]
    func LookupEntitlement(ctx *Context, args *LookupEntitlementArgs, opts ...InvokeOption) (*LookupEntitlementResult, error)
    func LookupEntitlementOutput(ctx *Context, args *LookupEntitlementOutputArgs, opts ...InvokeOption) LookupEntitlementResultOutput

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

    public static class GetEntitlement 
    {
        public static Task<GetEntitlementResult> InvokeAsync(GetEntitlementArgs args, InvokeOptions? opts = null)
        public static Output<GetEntitlementResult> Invoke(GetEntitlementInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEntitlementResult> getEntitlement(GetEntitlementArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:appstream:getEntitlement
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the entitlement.
    StackName string
    The name of the stack.
    Name string
    The name of the entitlement.
    StackName string
    The name of the stack.
    name String
    The name of the entitlement.
    stackName String
    The name of the stack.
    name string
    The name of the entitlement.
    stackName string
    The name of the stack.
    name str
    The name of the entitlement.
    stack_name str
    The name of the stack.
    name String
    The name of the entitlement.
    stackName String
    The name of the stack.

    getEntitlement Result

    The following output properties are available:

    AppVisibility string
    Specifies whether to entitle all apps or only selected apps.
    Attributes List<Pulumi.AwsNative.AppStream.Outputs.EntitlementAttribute>
    The attributes of the entitlement.
    CreatedTime string
    The time when the entitlement was created.
    Description string
    The description of the entitlement.
    LastModifiedTime string
    The time when the entitlement was last modified.
    AppVisibility string
    Specifies whether to entitle all apps or only selected apps.
    Attributes []EntitlementAttribute
    The attributes of the entitlement.
    CreatedTime string
    The time when the entitlement was created.
    Description string
    The description of the entitlement.
    LastModifiedTime string
    The time when the entitlement was last modified.
    appVisibility String
    Specifies whether to entitle all apps or only selected apps.
    attributes List<EntitlementAttribute>
    The attributes of the entitlement.
    createdTime String
    The time when the entitlement was created.
    description String
    The description of the entitlement.
    lastModifiedTime String
    The time when the entitlement was last modified.
    appVisibility string
    Specifies whether to entitle all apps or only selected apps.
    attributes EntitlementAttribute[]
    The attributes of the entitlement.
    createdTime string
    The time when the entitlement was created.
    description string
    The description of the entitlement.
    lastModifiedTime string
    The time when the entitlement was last modified.
    app_visibility str
    Specifies whether to entitle all apps or only selected apps.
    attributes Sequence[EntitlementAttribute]
    The attributes of the entitlement.
    created_time str
    The time when the entitlement was created.
    description str
    The description of the entitlement.
    last_modified_time str
    The time when the entitlement was last modified.
    appVisibility String
    Specifies whether to entitle all apps or only selected apps.
    attributes List<Property Map>
    The attributes of the entitlement.
    createdTime String
    The time when the entitlement was created.
    description String
    The description of the entitlement.
    lastModifiedTime String
    The time when the entitlement was last modified.

    Supporting Types

    EntitlementAttribute

    Name string

    A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application.

    The following are supported values:

    • roles
    • department
    • organization
    • groups
    • title
    • costCenter
    • userType
    Value string
    A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application.
    Name string

    A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application.

    The following are supported values:

    • roles
    • department
    • organization
    • groups
    • title
    • costCenter
    • userType
    Value string
    A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application.
    name String

    A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application.

    The following are supported values:

    • roles
    • department
    • organization
    • groups
    • title
    • costCenter
    • userType
    value String
    A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application.
    name string

    A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application.

    The following are supported values:

    • roles
    • department
    • organization
    • groups
    • title
    • costCenter
    • userType
    value string
    A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application.
    name str

    A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application.

    The following are supported values:

    • roles
    • department
    • organization
    • groups
    • title
    • costCenter
    • userType
    value str
    A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application.
    name String

    A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application.

    The following are supported values:

    • roles
    • department
    • organization
    • groups
    • title
    • costCenter
    • userType
    value String
    A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application.

    Package Details

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

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

    AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi