Skip to content

Create Entitlement

appstream_create_entitlement R Documentation

Creates a new entitlement

Description

Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

Usage

appstream_create_entitlement(Name, StackName, Description,
  AppVisibility, Attributes)

Arguments

Name

[required] The name of the entitlement.

StackName

[required] The name of the stack with which the entitlement is associated.

Description

The description of the entitlement.

AppVisibility

[required] Specifies whether all or selected apps are entitled.

Attributes

[required] The attributes of the entitlement.

Value

A list with the following syntax:

list(
  Entitlement = list(
    Name = "string",
    StackName = "string",
    Description = "string",
    AppVisibility = "ALL"|"ASSOCIATED",
    Attributes = list(
      list(
        Name = "string",
        Value = "string"
      )
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$create_entitlement(
  Name = "string",
  StackName = "string",
  Description = "string",
  AppVisibility = "ALL"|"ASSOCIATED",
  Attributes = list(
    list(
      Name = "string",
      Value = "string"
    )
  )
)