types

package
v1.20.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 3 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplicationDependencySummary

type ApplicationDependencySummary struct {

	// The Amazon Resource Name (ARN) of the nested application.
	//
	// This member is required.
	ApplicationId *string

	// The semantic version of the nested application.
	//
	// This member is required.
	SemanticVersion *string
	// contains filtered or unexported fields
}

A nested application summary.

type ApplicationPolicyStatement

type ApplicationPolicyStatement struct {

	// For the list of actions supported for this operation, see Application
	// Permissions (https://docs.aws.amazon.com/serverlessrepo/latest/devguide/access-control-resource-based.html#application-permissions)
	// .
	//
	// This member is required.
	Actions []string

	// An array of AWS account IDs, or * to make the application public.
	//
	// This member is required.
	Principals []string

	// An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#principal-org-id)
	// global condition key.
	PrincipalOrgIDs []string

	// A unique ID for the statement.
	StatementId *string
	// contains filtered or unexported fields
}

Policy statement applied to the application.

type ApplicationSummary

type ApplicationSummary struct {

	// The application Amazon Resource Name (ARN).
	//
	// This member is required.
	ApplicationId *string

	// The name of the author publishing the app.Minimum length=1. Maximum
	// length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
	//
	// This member is required.
	Author *string

	// The description of the application.Minimum length=1. Maximum length=256
	//
	// This member is required.
	Description *string

	// The name of the application.Minimum length=1. Maximum length=140Pattern:
	// "[a-zA-Z0-9\\-]+";
	//
	// This member is required.
	Name *string

	// The date and time this resource was created.
	CreationTime *string

	// A URL with more information about the application, for example the location of
	// your GitHub repository for the application.
	HomePageUrl *string

	// Labels to improve discovery of apps in search results.Minimum length=1. Maximum
	// length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";
	Labels []string

	// A valid identifier from https://spdx.org/licenses/ (https://spdx.org/licenses/) .
	SpdxLicenseId *string
	// contains filtered or unexported fields
}

Summary of details about the application.

type BadRequestException

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

One of the parameters in the request is invalid.

func (*BadRequestException) Error

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage

func (e *BadRequestException) ErrorMessage() string

type Capability

type Capability string
const (
	CapabilityCapabilityIam            Capability = "CAPABILITY_IAM"
	CapabilityCapabilityNamedIam       Capability = "CAPABILITY_NAMED_IAM"
	CapabilityCapabilityAutoExpand     Capability = "CAPABILITY_AUTO_EXPAND"
	CapabilityCapabilityResourcePolicy Capability = "CAPABILITY_RESOURCE_POLICY"
)

Enum values for Capability

func (Capability) Values added in v0.29.0

func (Capability) Values() []Capability

Values returns all known values for Capability. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

The resource already exists.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type ForbiddenException

type ForbiddenException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

The client is not authenticated.

func (*ForbiddenException) Error

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault

func (e *ForbiddenException) ErrorFault() smithy.ErrorFault

func (*ForbiddenException) ErrorMessage

func (e *ForbiddenException) ErrorMessage() string

type InternalServerErrorException

type InternalServerErrorException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

The AWS Serverless Application Repository service encountered an internal error.

func (*InternalServerErrorException) Error

func (*InternalServerErrorException) ErrorCode

func (e *InternalServerErrorException) ErrorCode() string

func (*InternalServerErrorException) ErrorFault

func (*InternalServerErrorException) ErrorMessage

func (e *InternalServerErrorException) ErrorMessage() string

type NotFoundException

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

The resource (for example, an access policy statement) specified in the request doesn't exist.

func (*NotFoundException) Error

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage

func (e *NotFoundException) ErrorMessage() string

type ParameterDefinition

type ParameterDefinition struct {

	// The name of the parameter.
	//
	// This member is required.
	Name *string

	// A list of AWS SAM resources that use this parameter.
	//
	// This member is required.
	ReferencedByResources []string

	// A regular expression that represents the patterns to allow for String types.
	AllowedPattern *string

	// An array containing the list of values allowed for the parameter.
	AllowedValues []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.
	ConstraintDescription *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.
	DefaultValue *string

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

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

	// A numeric value that determines the largest numeric value that you want to
	// allow for Number types.
	MaxValue *int32

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

	// A numeric value that determines the smallest numeric value that you want to
	// allow for Number types.
	MinValue *int32

	// 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 (*****).
	NoEcho *bool

	// 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"].
	Type *string
	// contains filtered or unexported fields
}

Parameters supported by the application.

type ParameterValue

type ParameterValue struct {

	// The key associated with the parameter. If you don't specify a key and value for
	// a particular parameter, AWS CloudFormation uses the default value that is
	// specified in your template.
	//
	// This member is required.
	Name *string

	// The input value associated with the parameter.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Parameter value of the application.

type RollbackConfiguration

type RollbackConfiguration struct {

	// This property corresponds to the content of the same name for the AWS
	// CloudFormation RollbackConfiguration (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration)
	// Data Type.
	MonitoringTimeInMinutes *int32

	// This property corresponds to the content of the same name for the AWS
	// CloudFormation RollbackConfiguration (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration)
	// Data Type.
	RollbackTriggers []RollbackTrigger
	// contains filtered or unexported fields
}

This property corresponds to the AWS CloudFormation RollbackConfiguration (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration) Data Type.

type RollbackTrigger

type RollbackTrigger struct {

	// This property corresponds to the content of the same name for the AWS
	// CloudFormation RollbackTrigger (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger)
	// Data Type.
	//
	// This member is required.
	Arn *string

	// This property corresponds to the content of the same name for the AWS
	// CloudFormation RollbackTrigger (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger)
	// Data Type.
	//
	// This member is required.
	Type *string
	// contains filtered or unexported fields
}

This property corresponds to the AWS CloudFormation RollbackTrigger (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger) Data Type.

type Status

type Status string
const (
	StatusPreparing Status = "PREPARING"
	StatusActive    Status = "ACTIVE"
	StatusExpired   Status = "EXPIRED"
)

Enum values for Status

func (Status) Values added in v0.29.0

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Tag

type Tag struct {

	// This property corresponds to the content of the same name for the AWS
	// CloudFormation Tag (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag)
	// Data Type.
	//
	// This member is required.
	Key *string

	// This property corresponds to the content of the same name for the AWS
	// CloudFormation Tag (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag)
	// Data Type.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

This property corresponds to the AWS CloudFormation Tag (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag) Data Type.

type TooManyRequestsException

type TooManyRequestsException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

The client is sending more than the allowed number of requests per unit of time.

func (*TooManyRequestsException) Error

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage

func (e *TooManyRequestsException) ErrorMessage() string

type Version

type Version struct {

	// The application Amazon Resource Name (ARN).
	//
	// This member is required.
	ApplicationId *string

	// The date and time this resource was created.
	//
	// This member is required.
	CreationTime *string

	// An array of parameter types supported by the application.
	//
	// This member is required.
	ParameterDefinitions []ParameterDefinition

	// 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, CAPABILITY_RESOURCE_POLICY, and
	// CAPABILITY_AUTO_EXPAND.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)
	// .Applications that contain one or more nested applications require you to
	// specify CAPABILITY_AUTO_EXPAND.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.
	//
	// This member is required.
	RequiredCapabilities []Capability

	// Whether all of the AWS resources contained in this application are supported in
	// the region in which it is being retrieved.
	//
	// This member is required.
	ResourcesSupported *bool

	// The semantic version of the application: https://semver.org/ (https://semver.org/)
	//
	// This member is required.
	SemanticVersion *string

	// A link to the packaged AWS SAM template of your application.
	//
	// This member is required.
	TemplateUrl *string

	// A link to the S3 object that contains the ZIP archive of the source code for
	// this version of your application.Maximum size 50 MB
	SourceCodeArchiveUrl *string

	// A link to a public repository for the source code of your application, for
	// example the URL of a specific GitHub commit.
	SourceCodeUrl *string
	// contains filtered or unexported fields
}

Application version details.

type VersionSummary

type VersionSummary struct {

	// The application Amazon Resource Name (ARN).
	//
	// This member is required.
	ApplicationId *string

	// The date and time this resource was created.
	//
	// This member is required.
	CreationTime *string

	// The semantic version of the application: https://semver.org/ (https://semver.org/)
	//
	// This member is required.
	SemanticVersion *string

	// A link to a public repository for the source code of your application, for
	// example the URL of a specific GitHub commit.
	SourceCodeUrl *string
	// contains filtered or unexported fields
}

An application version summary.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL