Class: Aws::ECRPublic::Types::RepositoryCatalogDataInput

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

Overview

Note:

When making an API call, you may pass RepositoryCatalogDataInput data as a hash:

{
  description: "RepositoryDescription",
  architectures: ["Architecture"],
  operating_systems: ["OperatingSystem"],
  logo_image_blob: "data",
  about_text: "AboutText",
  usage_text: "UsageText",
}

An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#about_textString

A detailed description of the contents of the repository. It is publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format.

Returns:

  • (String)


1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 1859

class RepositoryCatalogDataInput < Struct.new(
  :description,
  :architectures,
  :operating_systems,
  :logo_image_blob,
  :about_text,
  :usage_text)
  SENSITIVE = []
  include Aws::Structure
end

#architecturesArray<String>

The system architecture that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported architectures will appear as badges on the repository and are used as search filters.

  • Linux

  • Windows

If an unsupported tag is added to your repository catalog data, it will be associated with the repository and can be retrieved using the API but will not be discoverable in the Amazon ECR Public Gallery.

Returns:

  • (Array<String>)


1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 1859

class RepositoryCatalogDataInput < Struct.new(
  :description,
  :architectures,
  :operating_systems,
  :logo_image_blob,
  :about_text,
  :usage_text)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A short description of the contents of the repository. This text appears in both the image details and also when searching for repositories on the Amazon ECR Public Gallery.

Returns:

  • (String)


1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 1859

class RepositoryCatalogDataInput < Struct.new(
  :description,
  :architectures,
  :operating_systems,
  :logo_image_blob,
  :about_text,
  :usage_text)
  SENSITIVE = []
  include Aws::Structure
end

#logo_image_blobString

The base64-encoded repository logo payload.

The repository logo is only publicly visible in the Amazon ECR Public Gallery for verified accounts.

Returns:

  • (String)


1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 1859

class RepositoryCatalogDataInput < Struct.new(
  :description,
  :architectures,
  :operating_systems,
  :logo_image_blob,
  :about_text,
  :usage_text)
  SENSITIVE = []
  include Aws::Structure
end

#operating_systemsArray<String>

The operating systems that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported operating systems will appear as badges on the repository and are used as search filters.

  • ARM

  • ARM 64

  • x86

  • x86-64

If an unsupported tag is added to your repository catalog data, it will be associated with the repository and can be retrieved using the API but will not be discoverable in the Amazon ECR Public Gallery.

Returns:

  • (Array<String>)


1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 1859

class RepositoryCatalogDataInput < Struct.new(
  :description,
  :architectures,
  :operating_systems,
  :logo_image_blob,
  :about_text,
  :usage_text)
  SENSITIVE = []
  include Aws::Structure
end

#usage_textString

Detailed information on how to use the contents of the repository. It is publicly visible in the Amazon ECR Public Gallery. The usage text provides context, support information, and additional usage details for users of the repository. The text must be in markdown format.

Returns:

  • (String)


1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/types.rb', line 1859

class RepositoryCatalogDataInput < Struct.new(
  :description,
  :architectures,
  :operating_systems,
  :logo_image_blob,
  :about_text,
  :usage_text)
  SENSITIVE = []
  include Aws::Structure
end