2.170.0

enum ArnFormat

LanguageType name
.NETAmazon.CDK.ArnFormat
Gogithub.com/aws/aws-cdk-go/awscdk/v2#ArnFormat
Javasoftware.amazon.awscdk.ArnFormat
Pythonaws_cdk.ArnFormat
TypeScript (source)aws-cdk-lib » ArnFormat

An enum representing the various ARN formats that different services use.

Example

declare const stack: Stack;

// Builds "arn:<PARTITION>:lambda:<REGION>:<ACCOUNT>:function:MyFunction"
stack.formatArn({
  service: 'lambda',
  resource: 'function',
  arnFormat: ArnFormat.COLON_RESOURCE_NAME,
  resourceName: 'MyFunction'
});

Members

NameDescription
NO_RESOURCE_NAMEThis represents a format where there is no 'resourceName' part.
COLON_RESOURCE_NAMEThis represents a format where the 'resource' and 'resourceName' parts are separated with a colon.
SLASH_RESOURCE_NAMEThis represents a format where the 'resource' and 'resourceName' parts are separated with a slash.
SLASH_RESOURCE_SLASH_RESOURCE_NAMEThis represents a format where the 'resource' and 'resourceName' parts are seperated with a slash, but there is also an additional slash after the colon separating 'account' from 'resource'.

NO_RESOURCE_NAME

This represents a format where there is no 'resourceName' part.

This format is used for S3 resources, like 'arn:aws:s3:::bucket'. Everything after the last colon is considered the 'resource', even if it contains slashes, like in 'arn:aws:s3:::bucket/object.zip'.

COLON_RESOURCE_NAME

This represents a format where the 'resource' and 'resourceName' parts are separated with a colon.

Like in: 'arn:aws:service:region:account:resource:resourceName'. Everything after the last colon is considered the 'resourceName', even if it contains slashes, like in 'arn:aws:apigateway:region:account:resource:/test/mydemoresource/*'.

SLASH_RESOURCE_NAME

This represents a format where the 'resource' and 'resourceName' parts are separated with a slash.

Like in: 'arn:aws:service:region:account:resource/resourceName'. Everything after the separating slash is considered the 'resourceName', even if it contains colons, like in 'arn:aws:cognito-sync:region:account:identitypool/us-east-1:1a1a1a1a-ffff-1111-9999-12345678:bla'.

SLASH_RESOURCE_SLASH_RESOURCE_NAME

This represents a format where the 'resource' and 'resourceName' parts are seperated with a slash, but there is also an additional slash after the colon separating 'account' from 'resource'.

Like in: 'arn:aws:service:region:account:/resource/resourceName'. Note that the leading slash is not included in the parsed 'resource' part.

← PreviousNext →