You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb

Overview

Create an application request.

Instance Attribute Summary collapse

Instance Attribute Details

#authorString

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

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

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#descriptionString

The description of the application.

Minimum length=1. Maximum length=256

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#home_page_urlString

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

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#labelsArray<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>)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#license_bodyString

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)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#license_urlString

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)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#nameString

The name of the application that you want to publish.

Minimum length=1. Maximum length=140

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

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#readme_bodyString

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)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#readme_urlString

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)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#semantic_versionString

The semantic version of the application:

https://semver.org/

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#source_code_archive_urlString

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)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#source_code_urlString

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

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#spdx_license_idString

A valid identifier from https://spdx.org/licenses/.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#template_bodyString

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)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end

#template_urlString

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)


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 485

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)
  include Aws::Structure
end