1. Packages
  2. AWS Native
  3. API Docs
  4. appstream
  5. Entitlement

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

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.appstream.Entitlement

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::AppStream::Entitlement

    Create Entitlement Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Entitlement(name: string, args: EntitlementArgs, opts?: CustomResourceOptions);
    @overload
    def Entitlement(resource_name: str,
                    args: EntitlementArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Entitlement(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    app_visibility: Optional[str] = None,
                    attributes: Optional[Sequence[EntitlementAttributeArgs]] = None,
                    stack_name: Optional[str] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None)
    func NewEntitlement(ctx *Context, name string, args EntitlementArgs, opts ...ResourceOption) (*Entitlement, error)
    public Entitlement(string name, EntitlementArgs args, CustomResourceOptions? opts = null)
    public Entitlement(String name, EntitlementArgs args)
    public Entitlement(String name, EntitlementArgs args, CustomResourceOptions options)
    
    type: aws-native:appstream:Entitlement
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EntitlementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EntitlementArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EntitlementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntitlementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntitlementArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const entitlementResource = new aws_native.appstream.Entitlement("entitlementResource", {
        appVisibility: "string",
        attributes: [{
            name: "string",
            value: "string",
        }],
        stackName: "string",
        description: "string",
        name: "string",
    });
    
    Coming soon!
    

    Entitlement Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Entitlement resource accepts the following input properties:

    AppVisibility string
    Specifies whether to entitle all apps or only selected apps.
    Attributes List<Pulumi.AwsNative.AppStream.Inputs.EntitlementAttribute>
    The attributes of the entitlement.
    StackName string
    The name of the stack.
    Description string
    The description of the entitlement.
    Name string
    The name of the entitlement.
    AppVisibility string
    Specifies whether to entitle all apps or only selected apps.
    Attributes []EntitlementAttributeArgs
    The attributes of the entitlement.
    StackName string
    The name of the stack.
    Description string
    The description of the entitlement.
    Name string
    The name of the entitlement.
    appVisibility String
    Specifies whether to entitle all apps or only selected apps.
    attributes List<EntitlementAttribute>
    The attributes of the entitlement.
    stackName String
    The name of the stack.
    description String
    The description of the entitlement.
    name String
    The name of the entitlement.
    appVisibility string
    Specifies whether to entitle all apps or only selected apps.
    attributes EntitlementAttribute[]
    The attributes of the entitlement.
    stackName string
    The name of the stack.
    description string
    The description of the entitlement.
    name string
    The name of the entitlement.
    app_visibility str
    Specifies whether to entitle all apps or only selected apps.
    attributes Sequence[EntitlementAttributeArgs]
    The attributes of the entitlement.
    stack_name str
    The name of the stack.
    description str
    The description of the entitlement.
    name str
    The name of the entitlement.
    appVisibility String
    Specifies whether to entitle all apps or only selected apps.
    attributes List<Property Map>
    The attributes of the entitlement.
    stackName String
    The name of the stack.
    description String
    The description of the entitlement.
    name String
    The name of the entitlement.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Entitlement resource produces the following output properties:

    CreatedTime string
    The time when the entitlement was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The time when the entitlement was last modified.
    CreatedTime string
    The time when the entitlement was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The time when the entitlement was last modified.
    createdTime String
    The time when the entitlement was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The time when the entitlement was last modified.
    createdTime string
    The time when the entitlement was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime string
    The time when the entitlement was last modified.
    created_time str
    The time when the entitlement was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_time str
    The time when the entitlement was last modified.
    createdTime String
    The time when the entitlement was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The time when the entitlement was last modified.

    Supporting Types

    EntitlementAttribute, EntitlementAttributeArgs

    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

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

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi