AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ParameterDefinition

import "github.com/aws/aws-sdk-go/service/serverlessapplicationrepository"

type ParameterDefinition struct { AllowedPattern *string `locationName:"allowedPattern" type:"string"` AllowedValues []*string `locationName:"allowedValues" type:"list"` ConstraintDescription *string `locationName:"constraintDescription" type:"string"` DefaultValue *string `locationName:"defaultValue" type:"string"` Description *string `locationName:"description" type:"string"` MaxLength *int64 `locationName:"maxLength" type:"integer"` MaxValue *int64 `locationName:"maxValue" type:"integer"` MinLength *int64 `locationName:"minLength" type:"integer"` MinValue *int64 `locationName:"minValue" type:"integer"` Name *string `locationName:"name" type:"string" required:"true"` NoEcho *bool `locationName:"noEcho" type:"boolean"` ReferencedByResources []*string `locationName:"referencedByResources" type:"list" required:"true"` Type *string `locationName:"type" type:"string"` }

Parameters supported by the application.

AllowedPattern

Type: *string

A regular expression that represents the patterns to allow for String types.

AllowedValues

Type: []*string

An array containing the list of values allowed for the parameter.

ConstraintDescription

Type: *string

A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

By adding a constraint description, such as "must contain only uppercase and lowercase letters and numbers," you can display the following customized error message:

Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.

DefaultValue

Type: *string

A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.

Description

Type: *string

A string of up to 4,000 characters that describes the parameter.

MaxLength

Type: *int64

An integer value that determines the largest number of characters that you want to allow for String types.

MaxValue

Type: *int64

A numeric value that determines the largest numeric value that you want to allow for Number types.

MinLength

Type: *int64

An integer value that determines the smallest number of characters that you want to allow for String types.

MinValue

Type: *int64

A numeric value that determines the smallest numeric value that you want to allow for Number types.

Name

Type: *string

The name of the parameter.

Name is a required field

NoEcho

Type: *bool

Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*****).

ReferencedByResources

Type: []*string

A list of AWS SAM resources that use this parameter.

ReferencedByResources is a required field

Type

Type: *string

The type of the parameter.

Valid values: String | Number | List<Number> | CommaDelimitedList

String: A literal string.

For example, users can specify "MyUserName".

Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.

For example, users might specify "8888".

List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.

For example, users might specify "80,20", and then Ref results in ["80","20"].

CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.

For example, users might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].

Method

GoString

func (s ParameterDefinition) GoString() string

GoString returns the string representation

SetAllowedPattern

func (s *ParameterDefinition) SetAllowedPattern(v string) *ParameterDefinition

SetAllowedPattern sets the AllowedPattern field's value.

SetAllowedValues

func (s *ParameterDefinition) SetAllowedValues(v []*string) *ParameterDefinition

SetAllowedValues sets the AllowedValues field's value.

SetConstraintDescription

func (s *ParameterDefinition) SetConstraintDescription(v string) *ParameterDefinition

SetConstraintDescription sets the ConstraintDescription field's value.

SetDefaultValue

func (s *ParameterDefinition) SetDefaultValue(v string) *ParameterDefinition

SetDefaultValue sets the DefaultValue field's value.

SetDescription

func (s *ParameterDefinition) SetDescription(v string) *ParameterDefinition

SetDescription sets the Description field's value.

SetMaxLength

func (s *ParameterDefinition) SetMaxLength(v int64) *ParameterDefinition

SetMaxLength sets the MaxLength field's value.

SetMaxValue

func (s *ParameterDefinition) SetMaxValue(v int64) *ParameterDefinition

SetMaxValue sets the MaxValue field's value.

SetMinLength

func (s *ParameterDefinition) SetMinLength(v int64) *ParameterDefinition

SetMinLength sets the MinLength field's value.

SetMinValue

func (s *ParameterDefinition) SetMinValue(v int64) *ParameterDefinition

SetMinValue sets the MinValue field's value.

SetName

func (s *ParameterDefinition) SetName(v string) *ParameterDefinition

SetName sets the Name field's value.

SetNoEcho

func (s *ParameterDefinition) SetNoEcho(v bool) *ParameterDefinition

SetNoEcho sets the NoEcho field's value.

SetReferencedByResources

func (s *ParameterDefinition) SetReferencedByResources(v []*string) *ParameterDefinition

SetReferencedByResources sets the ReferencedByResources field's value.

SetType

func (s *ParameterDefinition) SetType(v string) *ParameterDefinition

SetType sets the Type field's value.

String

func (s ParameterDefinition) String() string

String returns the string representation

On this page: