Module cloudsmith¶

“Cloudmith module”

License: Inmanta EULA

Version: 0.1.0

Typedefs¶

typedef cloudsmith::resources::repository_token_request::limit_bandwidth¶

Base type int
Type constraint ((self >= -9223372036854776000) and (self <= 9223372036854776000))

typedef cloudsmith::resources::repository_token_request::limit_num_clients¶

Base type int
Type constraint ((self >= -9223372036854776000) and (self <= 9223372036854776000))

typedef cloudsmith::resources::repository_token_request::limit_num_downloads¶

Base type int
Type constraint ((self >= -9223372036854776000) and (self <= 9223372036854776000))

typedef cloudsmith::resources::repository_token_request::limit_package_query¶

Base type string
Type constraint (std::length(self) <= 1024)

typedef cloudsmith::resources::repository_token_request::limit_path_query¶

Base type string
Type constraint (std::length(self) <= 1024)

typedef cloudsmith::resources::repository_token_request::name¶

Base type string
Type constraint (std::length(self) >= 1)

typedef cloudsmith::resources::repository_token_request::token¶

Base type string
Type constraint (std::length(self) >= 1)

Entities¶

entity cloudsmith::Api¶

Parents: std::Dataclass

Entity describing an instance of the cloudsmith api

attribute string agent_name='cloudsmith.io'¶: The name of the agent for all resources deployed on this api.

attribute string base_url='https://api.cloudsmith.io/'¶: The base url to use to reach the api.

attribute string api_token¶: The token to use to authenticate to the api.

The following implements statements select implementations for this entity:

std::none constraint true

entity cloudsmith::BaseResource¶

Parents: std::Entity

Base entity for all resources.

relation cloudsmith::Api api [1]¶

entity cloudsmith::EntitlementDiscoveryResource¶

Parents: std::DiscoveryResource, cloudsmith::RepoResource

A resource that will discover all Entitlements in a repo

The following implements statements select implementations for this entity:

std::none constraint true

entity cloudsmith::PackagesSync¶

Parents: cloudsmith::RepoResource, std::PurgeableResource

This resource allows to sync all the packages of a repository to another repository. This only works for python packages, and takes care of syncing all versions of each package.

attribute string destination¶: The destination repository.

The following implements statements select implementations for this entity:

std::none constraint true

entity cloudsmith::RepoResource¶

Parents: cloudsmith::BaseResource

A resource that belongs inside a repository (i.e. an entitlement token)

attribute string namespace¶: The namespace of the the repo (the organization owning the repo)

attribute string repo¶: The name of the repo

entity cloudsmith::resources::Entitlement¶

Parents: std::PurgeableResource, cloudsmith::RepoResource

attribute bool? eula_required=null¶: If checked, a EULA acceptance is required for this token.

attribute bool? is_active=null¶: If enabled, the token will allow downloads based on configured restrictions (if any).

attribute cloudsmith::resources::repository_token_request::limit_bandwidth? limit_bandwidth=null¶: The maximum download bandwidth allowed for the token. Values are expressed as the selected unit of bandwidth. Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.

attribute string? limit_bandwidth_unit=null¶

attribute string? limit_date_range_from=null¶: The starting date/time the token is allowed to be used from.

attribute string? limit_date_range_to=null¶: The ending date/time the token is allowed to be used until.

attribute cloudsmith::resources::repository_token_request::limit_num_clients? limit_num_clients=null¶: The maximum number of unique clients allowed for the token. Please note that since clients are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.

attribute cloudsmith::resources::repository_token_request::limit_num_downloads? limit_num_downloads=null¶: The maximum number of downloads allowed for the token. Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.

attribute cloudsmith::resources::repository_token_request::limit_package_query? limit_package_query=null¶: The package-based search query to apply to restrict downloads to. This uses the same syntax as the standard search used for repositories, and also supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. This will still allow access to non-package files, such as metadata.

attribute cloudsmith::resources::repository_token_request::limit_path_query? limit_path_query=null¶: The path-based search query to apply to restrict downloads to. This supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. The path evaluated does not include the domain name, the namespace, the entitlement code used, the package format, etc. and it always starts with a forward slash.

attribute cloudsmith::resources::repository_token_request::name name¶

attribute string? scheduled_reset_at=null¶: The time at which the scheduled reset period has elapsed and the token limits were automatically reset to zero.