software.amazon.awscdk.core

Interface ArnComponents

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ArnComponents.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:00.921Z")
 @Stability(value=Experimental)
public interface ArnComponents
extends software.amazon.jsii.JsiiSerializable

Example:

 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 IStage approveStage = pipeline.addStage(StageOptions.builder().stageName("Approve").build());
 ManualApprovalAction manualApprovalAction = ManualApprovalAction.Builder.create()
         .actionName("Approve")
         .build();
 approveStage.addAction(manualApprovalAction);
 IRole role = Role.fromRoleArn(this, "Admin", Arn.format(ArnComponents.builder().service("iam").resource("role").resourceName("Admin").build(), this));
 manualApprovalAction.grantManualApproval(role);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ArnComponents.Builder A builder for ArnComponents
static class	ArnComponents.Jsii$Proxy An implementation for ArnComponents

Method Summary

Modifier and Type	Method and Description
static ArnComponents.Builder	builder()
default String	getAccount() (experimental) The ID of the AWS account that owns the resource, without the hyphens.
default ArnFormat	getArnFormat() (experimental) The specific ARN format to use for this ARN value.
default String	getPartition() (experimental) The partition that the resource is in.
default String	getRegion() (experimental) The region the resource resides in.
String	getResource() (experimental) Resource type (e.g.
default String	getResourceName() (experimental) Resource name or path within the resource (i.e.
default String	getSep() Deprecated. use arnFormat instead
String	getService() (experimental) The service namespace that identifies the AWS product (for example, 's3', 'iam', 'codepipline').

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getResource

@Stability(value=Experimental)
 @NotNull
String getResource()

(experimental) Resource type (e.g. "table", "autoScalingGroup", "certificate"). For some resource types, e.g. S3 buckets, this field defines the bucket name.

getService

@Stability(value=Experimental)
 @NotNull
String getService()

(experimental) The service namespace that identifies the AWS product (for example, 's3', 'iam', 'codepipline').

getAccount

@Stability(value=Experimental)
 @Nullable
default String getAccount()

(experimental) The ID of the AWS 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.

Default: The account the stack is deployed to.

getArnFormat

@Stability(value=Experimental)
 @Nullable
default ArnFormat getArnFormat()

(experimental) The specific ARN format to use for this ARN value.

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

getPartition

@Stability(value=Experimental)
 @Nullable
default String getPartition()

(experimental) The partition that the resource is in.

For standard AWS regions, the partition is aws. If you have resources in other partitions, the partition is aws-partitionname. For example, the partition for resources in the China (Beijing) region is aws-cn.

Default: The AWS partition the stack is deployed to.

getRegion

@Stability(value=Experimental)
 @Nullable
default String getRegion()

(experimental) The region the resource resides in.

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

Default: The region the stack is deployed to.

getResourceName

@Stability(value=Experimental)
 @Nullable
default String getResourceName()

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

getSep

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getSep()

Deprecated. use arnFormat instead

(deprecated) Separator between resource type and the resource.

Can be either '/', ':' or an empty string. Will only be used if resourceName is defined.

Default: '/'

builder

@Stability(value=Experimental)
static ArnComponents.Builder builder()

Returns:

a ArnComponents.Builder of ArnComponents