Skip to content

ArnComponents

Initializer

import ros_cdk_core
ros_cdk_core.ArnComponents(
  resource: str,
  service: str,
  account: str = None,
  arn_format: ArnFormat = None,
  partition: str = None,
  region: str = None,
  resource_name: str = None
)

Properties

Name Type Description
resource str Resource type (e.g. "instance", "functions", "role"). For some resource types, e.g. OSS buckets, this field defines the bucket name.
service str The service namespace that identifies the ACS product (for example, 'ecs', 'fc', 'ram').
account str The ID of the ACS account that owns the resource, without the hyphens.
arn_format ArnFormat The specific ARN format to use for this ARN value.
partition str The partition that the resource is in.
region str The region the resource resides in.
resource_name str Resource name or path within the resource (i.e. OSS bucket object key) or a wildcard such as "*". This is service-dependent.

resourceRequired

resource: str
  • Type: str

Resource type (e.g. "instance", "functions", "role"). For some resource types, e.g. OSS buckets, this field defines the bucket name.


serviceRequired

service: str
  • Type: str

The service namespace that identifies the ACS product (for example, 'ecs', 'fc', 'ram').


accountOptional

account: str
  • Type: str
  • Default: The account the stack is deployed to.

The ID of the ACS account that owns the resource, without the hyphens.

For example, 123456789012. Note that the ARNs for some resources don't require an account number, so this component might be omitted.


arn_formatOptional

arn_format: ArnFormat
  • Type: ArnFormat
  • Default: uses value of sep as the separator for formatting, ArnFormat.SLASH_RESOURCE_NAME if that property was also not provided

The specific ARN format to use for this ARN value.


partitionOptional

partition: str
  • Type: str
  • Default: acs

The partition that the resource is in.


regionOptional

region: str
  • Type: str
  • Default: The region the stack is deployed to.

The region the resource resides in.

Note that the ARNs for some resources do not require a region, so this component might be omitted.


resource_nameOptional

resource_name: str
  • Type: str

Resource name or path within the resource (i.e. OSS bucket object key) or a wildcard such as "*". This is service-dependent.