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.Builder	account(String account) Sets the value of Account
ArnComponents	build() Builds the configured instance.
ArnComponents.Builder	partition(String partition) Sets the value of Partition
ArnComponents.Builder	region(String region) Sets the value of Region
ArnComponents.Builder	resource(String resource) Sets the value of Resource
ArnComponents.Builder	resourceName(String resourceName) Sets the value of ResourceName
ArnComponents.Builder	sep(String sep) Sets the value of Sep
ArnComponents.Builder	service(String service) 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

resource

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

Sets the value of Resource

Parameters:

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

Returns:

this

service

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

Sets the value of Service

Parameters:

service - The service namespace that identifies the AWS product (for example, 's3', 'iam', 'codepipline'). This parameter is required.

Returns:

this

account

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

Sets the value of Account

Parameters:

account - 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

partition

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

Sets the value of Partition

Parameters:

partition - The partition that the resource is in.

Returns:

this

region

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

Sets the value of Region

Parameters:

region - The region the resource resides in.

Returns:

this

resourceName

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

Sets the value of ResourceName

Parameters:

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

Returns:

this

sep

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

Sets the value of Sep

Parameters:

sep - 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