register

autogluon.cloud.register(*, role: str, bucket: str, region: str, backend: Literal['sagemaker', 'ray_aws'] = 'sagemaker', stack_name: str | None = None) → None[source]

Persist resource identifiers to ~/.autogluon/cloud.yaml under the given backend key.

Use this when you already have an IAM role and S3 bucket — for example, centrally provisioned by your platform team — and just want AutoGluon-Cloud to remember them.

If a config entry already exists for backend, it is overwritten. Other backends in the file are left untouched.

Parameters:

  • role – ARN of an IAM role suitable for SageMaker / Ray to assume. Named role for consistency with the SageMaker Python SDK (which uses role as the parameter name).

  • bucket – S3 bucket name where AutoGluon-Cloud will read/write artifacts.

  • region – AWS region for AutoGluon-Cloud operations.

  • backend – Which AutoGluon-Cloud backend the resources are intended for. Selects the slot in cloud.yaml.

  • stack_name – Optional CloudFormation stack name. If you deployed the resources via your own CFN stack and want teardown() to be able to delete it later, pass the name here. Defaults to None, meaning teardown will only remove the config entry, not touch AWS.