Class: Aws::ServerlessApplicationRepository::Types::CreateApplicationInput

Inherits:

Struct

Object
Struct
Aws::ServerlessApplicationRepository::Types::CreateApplicationInput

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-serverlessapplicationrepository/types.rb

Overview

Create an application request.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#author ⇒ String

The name of the author publishing the app.
#description ⇒ String

The description of the application.
#home_page_url ⇒ String

A URL with more information about the application, for example the location of your GitHub repository for the application.
#labels ⇒ Array<String>

Labels to improve discovery of apps in search results.
#license_body ⇒ String

A local text file that contains the license of the app that matches the spdxLicenseID value of your application.
#license_url ⇒ String

A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.
#name ⇒ String

The name of the application that you want to publish.
#readme_body ⇒ String

A local text readme file in Markdown language that contains a more detailed description of the application and how it works.
#readme_url ⇒ String

A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.
#semantic_version ⇒ String

The semantic version of the application:.
#source_code_archive_url ⇒ String

A link to the S3 object that contains the ZIP archive of the source code for this version of your application.
#source_code_url ⇒ String

A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.
#spdx_license_id ⇒ String

A valid identifier from [spdx.org/licenses/][1].
#template_body ⇒ String

The local raw packaged AWS SAM template file of your application.
#template_url ⇒ String

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

Instance Attribute Details

#author ⇒ `String`

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern “^[a-z0-9]((|-(?!-))*[a-z0-9])?$”;

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the application.

Minimum length=1. Maximum length=256

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#home_page_url ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#labels ⇒ `Array<String>`

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: “^[a-zA-Z0-9+\\-_:\\/@]+$”;

Returns:

(Array<String>)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#license_body ⇒ `String`

A local text file that contains the license of the app that matches the spdxLicenseID value of your application. The file has the format file://<path>/<filename>.

Maximum size 5 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#license_url ⇒ `String`

A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the application that you want to publish.

Minimum length=1. Maximum length=140

Pattern: “[a-zA-Z0-9\\-]+”;

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#readme_body ⇒ `String`

A local text readme file in Markdown language that contains a more detailed description of the application and how it works. The file has the format file://<path>/<filename>.

Maximum size 5 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#readme_url ⇒ `String`

A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#semantic_version ⇒ `String`

The semantic version of the application:

semver.org/][1: [1]: semver.org/

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#source_code_archive_url ⇒ `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

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#source_code_url ⇒ `String`

A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#spdx_license_id ⇒ `String`

A valid identifier from [spdx.org/licenses/][1].

[1]: spdx.org/licenses/

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#template_body ⇒ `String`

The local raw packaged AWS SAM template file of your application. The file has the format file://<path>/<filename>.

You can specify only one of templateBody and templateUrl; otherwise an error results.

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

#template_url ⇒ `String`

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

You can specify only one of templateBody and templateUrl; otherwise an error results.

Returns:

(String)

# File 'lib/aws-sdk-serverlessapplicationrepository/types.rb', line 514

class CreateApplicationInput < Struct.new(
  :author,
  :description,
  :home_page_url,
  :labels,
  :license_body,
  :license_url,
  :name,
  :readme_body,
  :readme_url,
  :semantic_version,
  :source_code_archive_url,
  :source_code_url,
  :spdx_license_id,
  :template_body,
  :template_url)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::ServerlessApplicationRepository::Types::CreateApplicationInput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#author ⇒ String

#description ⇒ String

#home_page_url ⇒ String

#labels ⇒ Array<String>

#license_body ⇒ String

#license_url ⇒ String

#name ⇒ String

#readme_body ⇒ String

#readme_url ⇒ String

#semantic_version ⇒ String

#source_code_archive_url ⇒ String

#source_code_url ⇒ String

#spdx_license_id ⇒ String

#template_body ⇒ String

#template_url ⇒ String

#author ⇒ `String`

#description ⇒ `String`

#home_page_url ⇒ `String`

#labels ⇒ `Array<String>`

#license_body ⇒ `String`

#license_url ⇒ `String`

#name ⇒ `String`

#readme_body ⇒ `String`

#readme_url ⇒ `String`

#semantic_version ⇒ `String`

#source_code_archive_url ⇒ `String`

#source_code_url ⇒ `String`

#spdx_license_id ⇒ `String`

#template_body ⇒ `String`

#template_url ⇒ `String`