ComponentParameterDetail - EC2 Image Builder
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ComponentParameterDetail

Defines a parameter that is used to provide configuration details for the component.

Contents

name

The name of this input parameter.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\x00]+

Required: Yes

type

The type of input this parameter provides. The currently supported value is "string".

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^String|Integer|Boolean|StringList$

Required: Yes

defaultValue

The default value of this parameter if no input is provided.

Type: Array of strings

Length Constraints: Minimum length of 0.

Pattern: [^\x00]*

Required: No

description

Describes this parameter.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [^\x00]+

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: