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.

Version

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

type Version struct { ApplicationId *string `locationName:"applicationId" type:"string" required:"true"` CreationTime *string `locationName:"creationTime" type:"string" required:"true"` ParameterDefinitions []*ParameterDefinition `locationName:"parameterDefinitions" type:"list" required:"true"` RequiredCapabilities []*string `locationName:"requiredCapabilities" type:"list" required:"true"` ResourcesSupported *bool `locationName:"resourcesSupported" type:"boolean" required:"true"` SemanticVersion *string `locationName:"semanticVersion" type:"string" required:"true"` SourceCodeUrl *string `locationName:"sourceCodeUrl" type:"string"` TemplateUrl *string `locationName:"templateUrl" type:"string" required:"true"` }

Application version details.

ApplicationId

Type: *string

The application Amazon Resource Name (ARN).

ApplicationId is a required field

CreationTime

Type: *string

The date and time this resource was created.

CreationTime is a required field

ParameterDefinitions

Parameters supported by the application.

RequiredCapabilities

Type: []*string

A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html), AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html), AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html), and AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html), AWS::IAM:Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html), AWS::ApplicationAutoScaling::ScalingPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html), AWS::S3::BucketPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html), AWS::SQS::QueuePolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html), and AWS::SNS::TopicPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html).

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

RequiredCapabilities is a required field

ResourcesSupported

Type: *bool

Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.

ResourcesSupported is a required field

SemanticVersion

Type: *string

The semantic version of the application:

https://semver.org/ (https://semver.org/)

SemanticVersion is a required field

SourceCodeUrl

Type: *string

A link to a public repository for the source code of your application.

TemplateUrl

Type: *string

A link to the packaged AWS SAM template of your application.

TemplateUrl is a required field

Method

GoString

func (s Version) GoString() string

GoString returns the string representation

SetApplicationId

func (s *Version) SetApplicationId(v string) *Version

SetApplicationId sets the ApplicationId field's value.

SetCreationTime

func (s *Version) SetCreationTime(v string) *Version

SetCreationTime sets the CreationTime field's value.

SetParameterDefinitions

func (s *Version) SetParameterDefinitions(v []*ParameterDefinition) *Version

SetParameterDefinitions sets the ParameterDefinitions field's value.

SetRequiredCapabilities

func (s *Version) SetRequiredCapabilities(v []*string) *Version

SetRequiredCapabilities sets the RequiredCapabilities field's value.

SetResourcesSupported

func (s *Version) SetResourcesSupported(v bool) *Version

SetResourcesSupported sets the ResourcesSupported field's value.

SetSemanticVersion

func (s *Version) SetSemanticVersion(v string) *Version

SetSemanticVersion sets the SemanticVersion field's value.

SetSourceCodeUrl

func (s *Version) SetSourceCodeUrl(v string) *Version

SetSourceCodeUrl sets the SourceCodeUrl field's value.

SetTemplateUrl

func (s *Version) SetTemplateUrl(v string) *Version

SetTemplateUrl sets the TemplateUrl field's value.

String

func (s Version) String() string

String returns the string representation

On this page: