software.amazon.awscdk.core

Class ArnComponents.Builder

java.lang.Object

software.amazon.awscdk.core.ArnComponents.Builder

Enclosing interface:

ArnComponents

@Stability(value=Stable)
public static final class ArnComponents.Builder
extends Object

A builder for ArnComponents

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ArnComponents	build() Builds the configured instance.
ArnComponents.Builder	withAccount(String value) Sets the value of Account
ArnComponents.Builder	withPartition(String value) Sets the value of Partition
ArnComponents.Builder	withRegion(String value) Sets the value of Region
ArnComponents.Builder	withResource(String value) Sets the value of Resource
ArnComponents.Builder	withResourceName(String value) Sets the value of ResourceName
ArnComponents.Builder	withSep(String value) Sets the value of Sep
ArnComponents.Builder	withService(String value) Sets the value of Service

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withResource

@Stability(value=Stable)
public ArnComponents.Builder withResource(String value)

Sets the value of Resource

Parameters:

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

Returns:

this

withService

@Stability(value=Stable)
public ArnComponents.Builder withService(String value)

Sets the value of Service

Parameters:

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

Returns:

this

withAccount

@Stability(value=Stable)
public ArnComponents.Builder withAccount(@Nullable
                                                                  String value)

Sets the value of Account

Parameters:

value - 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.

Returns:

this

withPartition

@Stability(value=Stable)
public ArnComponents.Builder withPartition(@Nullable
                                                                    String value)

Sets the value of Partition

Parameters:

value - The partition that the resource is in.

Returns:

this

withRegion

@Stability(value=Stable)
public ArnComponents.Builder withRegion(@Nullable
                                                                 String value)

Sets the value of Region

Parameters:

value - The region the resource resides in.

Returns:

this

withResourceName

@Stability(value=Stable)
public ArnComponents.Builder withResourceName(@Nullable
                                                                       String value)

Sets the value of ResourceName

Parameters:

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

Returns:

this

withSep

@Stability(value=Stable)
public ArnComponents.Builder withSep(@Nullable
                                                              String value)

Sets the value of Sep

Parameters:

value - Separator between resource type and the resource.

Returns:

this

build

@Stability(value=Stable)
public ArnComponents build()

Builds the configured instance.

Returns:

a new instance of ArnComponents

Throws:

NullPointerException - if any required attribute was not provided