software.amazon.awscdk.core

Class ArnComponents.Builder

java.lang.Object

software.amazon.awscdk.core.ArnComponents.Builder

Enclosing interface:

ArnComponents

public static final class ArnComponents.Builder
extends java.lang.Object

A builder for ArnComponents

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ArnComponents.Builder	account(java.lang.String account) Sets the value of ArnComponents.getAccount()
ArnComponents.Builder	arnFormat(ArnFormat arnFormat) Sets the value of ArnComponents.getArnFormat()
ArnComponents	build() Builds the configured instance.
ArnComponents.Builder	partition(java.lang.String partition) Sets the value of ArnComponents.getPartition()
ArnComponents.Builder	region(java.lang.String region) Sets the value of ArnComponents.getRegion()
ArnComponents.Builder	resource(java.lang.String resource) Sets the value of ArnComponents.getResource()
ArnComponents.Builder	resourceName(java.lang.String resourceName) Sets the value of ArnComponents.getResourceName()
ArnComponents.Builder	sep(java.lang.String sep) Deprecated. use arnFormat instead
ArnComponents.Builder	service(java.lang.String service) Sets the value of ArnComponents.getService()

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

public ArnComponents.Builder resource(java.lang.String resource)

Sets the value of ArnComponents.getResource()

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

public ArnComponents.Builder service(java.lang.String service)

Sets the value of ArnComponents.getService()

Parameters:

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

Returns:

this

account

public ArnComponents.Builder account(java.lang.String account)

Sets the value of ArnComponents.getAccount()

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

arnFormat

public ArnComponents.Builder arnFormat(ArnFormat arnFormat)

Sets the value of ArnComponents.getArnFormat()

Parameters:

arnFormat - The specific ARN format to use for this ARN value.

Returns:

this

partition

public ArnComponents.Builder partition(java.lang.String partition)

Sets the value of ArnComponents.getPartition()

Parameters:

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

Returns:

this

region

public ArnComponents.Builder region(java.lang.String region)

Sets the value of ArnComponents.getRegion()

Parameters:

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

Returns:

this

resourceName

public ArnComponents.Builder resourceName(java.lang.String resourceName)

Sets the value of ArnComponents.getResourceName()

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

@Deprecated
public ArnComponents.Builder sep(java.lang.String sep)

Deprecated. use arnFormat instead

Sets the value of ArnComponents.getSep()

Parameters:

sep - Separator between resource type and the resource. Can be either '/', ':' or an empty string. Will only be used if resourceName is defined.

Returns:

this

build

public ArnComponents build()

Builds the configured instance.

Returns:

a new instance of ArnComponents

Throws:

java.lang.NullPointerException - if any required attribute was not provided