account_preferences

Creates, updates, deletes, gets or lists an account_preferences resource.

Overview

Name	account_preferences
Type	Resource
Id	aws.efs.account_preferences

Fields

The following fields are returned by SELECT queries:

describe_account_preferences

Name	Datatype	Description
resource_id_type	string	Identifies the EFS resource ID preference, either LONG_ID (17 characters) or SHORT_ID (8 characters). (LONG_ID, SHORT_ID)
resources	array	Identifies the Amazon EFS resources to which the ID preference setting applies, FILE_SYSTEM and MOUNT_TARGET.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_account_preferences	select	region		Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
put_account_preferences	replace	region, ResourceIdType		Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs. Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_account_preferences

Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.

SELECT
resource_id_type,
resources
FROM aws.efs.account_preferences
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_account_preferences

Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs. Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.

REPLACE aws.efs.account_preferences
SET 
ResourceIdType = '{{ ResourceIdType }}'
WHERE 
region = '{{ region }}' --required
AND ResourceIdType = '{{ ResourceIdType }}' --required
RETURNING
resource_id_preference;