Package software.amazon.awscdk.core

Class ArnComponents.Builder

java.lang.Object
software.amazon.awscdk.core.ArnComponents.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<ArnComponents>
Enclosing interface:
ArnComponents
@Stability(Stable) public static final class ArnComponents.Builder extends Object implements software.amazon.jsii.Builder<ArnComponents>
A builder for ArnComponents

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • resource

      @Stability(Stable) public ArnComponents.Builder resource(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

      @Stability(Stable) public ArnComponents.Builder service(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

      @Stability(Stable) public ArnComponents.Builder account(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

      @Stability(Stable) 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

      @Stability(Stable) public ArnComponents.Builder partition(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

      @Stability(Stable) public ArnComponents.Builder region(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

      @Stability(Stable) public ArnComponents.Builder resourceName(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

      @Stability(Deprecated) @Deprecated public ArnComponents.Builder sep(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

      @Stability(Stable) public ArnComponents build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<ArnComponents>
      Returns:
      a new instance of ArnComponents
      Throws:
      NullPointerException - if any required attribute was not provided