/AWS1/CL_GMZSHADERCACHESUMMARY¶
Describes a shader cache associated with an Amazon GameLift Streams application.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_identifier TYPE /AWS1/GMZIDENTIFIER /AWS1/GMZIDENTIFIER¶
A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is
1271e693c50b940e228582f1ccdd4e27.
iv_applicationarn TYPE /AWS1/GMZARN /AWS1/GMZARN¶
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Optional arguments:¶
iv_status TYPE /AWS1/GMZSHADERCACHESTATUS /AWS1/GMZSHADERCACHESTATUS¶
The current status of the shader cache. Possible statuses include the following:
INITIALIZED: Amazon GameLift Streams received the request and is preparing the shader cache.
PROCESSING: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.
READY: The shader cache is replicated and available for use in stream sessions.
DELETING: Amazon GameLift Streams is deleting the shader cache.
ERROR: An error occurred during shader cache processing. Create a new shader cache to try again.
iv_lastupdatedat TYPE /AWS1/GMZTIMESTAMP /AWS1/GMZTIMESTAMP¶
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as:
2022-12-27T22:29:40+00:00(UTC).
iv_storagebytes TYPE /AWS1/GMZLONG /AWS1/GMZLONG¶
The total storage used by all compiled shader files in this shader cache, in bytes.
it_associatedstreamgroups TYPE /AWS1/CL_GMZARNLIST_W=>TT_ARNLIST TT_ARNLIST¶
The stream groups compatible with this shader cache. Compatibility is based on GPU type and GPU driver version. For more information on shader cache compatibility, see Shader caches in the Amazon GameLift Streams Developer Guide.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
Queryable Attributes¶
Identifier¶
A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is
1271e693c50b940e228582f1ccdd4e27.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IDENTIFIER() |
Getter for IDENTIFIER, with configurable default |
ASK_IDENTIFIER() |
Getter for IDENTIFIER w/ exceptions if field has no value |
HAS_IDENTIFIER() |
Determine if IDENTIFIER has a value |
ApplicationArn¶
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONARN() |
Getter for APPLICATIONARN, with configurable default |
ASK_APPLICATIONARN() |
Getter for APPLICATIONARN w/ exceptions if field has no valu |
HAS_APPLICATIONARN() |
Determine if APPLICATIONARN has a value |
Status¶
The current status of the shader cache. Possible statuses include the following:
INITIALIZED: Amazon GameLift Streams received the request and is preparing the shader cache.
PROCESSING: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.
READY: The shader cache is replicated and available for use in stream sessions.
DELETING: Amazon GameLift Streams is deleting the shader cache.
ERROR: An error occurred during shader cache processing. Create a new shader cache to try again.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
LastUpdatedAt¶
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as:
2022-12-27T22:29:40+00:00(UTC).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATEDAT() |
Getter for LASTUPDATEDAT, with configurable default |
ASK_LASTUPDATEDAT() |
Getter for LASTUPDATEDAT w/ exceptions if field has no value |
HAS_LASTUPDATEDAT() |
Determine if LASTUPDATEDAT has a value |
StorageBytes¶
The total storage used by all compiled shader files in this shader cache, in bytes.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STORAGEBYTES() |
Getter for STORAGEBYTES, with configurable default |
ASK_STORAGEBYTES() |
Getter for STORAGEBYTES w/ exceptions if field has no value |
HAS_STORAGEBYTES() |
Determine if STORAGEBYTES has a value |
AssociatedStreamGroups¶
The stream groups compatible with this shader cache. Compatibility is based on GPU type and GPU driver version. For more information on shader cache compatibility, see Shader caches in the Amazon GameLift Streams Developer Guide.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ASSOCIATEDSTREAMGROUPS() |
Getter for ASSOCIATEDSTREAMGROUPS, with configurable default |
ASK_ASSOCIATEDSTREAMGROUPS() |
Getter for ASSOCIATEDSTREAMGROUPS w/ exceptions if field has |
HAS_ASSOCIATEDSTREAMGROUPS() |
Determine if ASSOCIATEDSTREAMGROUPS has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_SHADERCACHESUMMARYLIST¶
TYPES TT_SHADERCACHESUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GMZSHADERCACHESUMMARY WITH DEFAULT KEY
.