Property
An object that defines a connection type for a compute environment.
Contents
- Description
-
A description of the property.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: Yes
- Name
-
The name of the property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- PropertyTypes
-
Describes the type of property.
Type: Array of strings
Valid Values:
USER_INPUT | SECRET | READ_ONLY | UNUSED | SECRET_OR_USER_INPUTRequired: Yes
- Required
-
Indicates whether the property is required.
Type: Boolean
Required: Yes
- AllowedValues
-
A list of
AllowedValueobjects representing the values allowed for the property.Type: Array of AllowedValue objects
Required: No
- DataOperationScopes
-
Indicates which data operations are applicable to the property.
Type: Array of strings
Valid Values:
READ | WRITERequired: No
- DefaultValue
-
The default value for the property.
Type: String
Required: No
- KeyOverride
-
A key name to use when sending this property in API requests, if different from the display name.
Type: String
Required: No
- PropertyLocation
-
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
Type: String
Valid Values:
HEADER | BODY | QUERY_PARAM | PATHRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
