Package software.amazon.awscdk.services.glue.alpha

Class Connection.Builder

java.lang.Object
software.amazon.awscdk.services.glue.alpha.Connection.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Connection>
Enclosing class:
Connection
@Stability(Experimental) public static final class Connection.Builder extends Object implements software.amazon.jsii.Builder<Connection>
(experimental) A fluent builder for Connection.

  • Method Details

    • create

      @Stability(Experimental) public static Connection.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Connection.Builder.

    • connectionName

      @Stability(Experimental) public Connection.Builder connectionName(String connectionName)
      (experimental) The name of the connection.

      Default: cloudformation generated name

      Parameters:
      connectionName - The name of the connection. This parameter is required.
      Returns:
      this

    • description

      @Stability(Experimental) public Connection.Builder description(String description)
      (experimental) The description of the connection.

      Default: no description

      Parameters:
      description - The description of the connection. This parameter is required.
      Returns:
      this

    • matchCriteria

      @Stability(Experimental) public Connection.Builder matchCriteria(List<String> matchCriteria)
      (experimental) A list of criteria that can be used in selecting this connection.

      This is useful for filtering the results of https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-connections.html

      Default: no match criteria

      Parameters:
      matchCriteria - A list of criteria that can be used in selecting this connection. This parameter is required.
      Returns:
      this

    • properties

      @Stability(Experimental) public Connection.Builder properties(Map<String,String> properties)
      (experimental) Key-Value pairs that define parameters for the connection.

      Default: empty properties

      Parameters:
      properties - Key-Value pairs that define parameters for the connection. This parameter is required.
      Returns:
      this
      See Also:

    • secret

      @Stability(Experimental) public Connection.Builder secret(ISecretRef secret)
      (experimental) A reference to a Secrets Manager secret holding the credentials for this connection.

      The secret is referenced through the connection's SECRET_ID property, so Glue reads the credentials at runtime and the secret value never appears in the synthesized template. Prefer this over placing credentials directly in properties. Accepts any secretsmanager.ISecret.

      Default: - no secret; any credentials must be supplied via `properties`

      Parameters:
      secret - A reference to a Secrets Manager secret holding the credentials for this connection. This parameter is required.
      Returns:
      this

    • securityGroups

      @Stability(Experimental) public Connection.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
      (experimental) The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.

      Default: no security group

      Parameters:
      securityGroups - The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC. This parameter is required.
      Returns:
      this

    • subnet

      @Stability(Experimental) public Connection.Builder subnet(ISubnet subnet)
      (experimental) The VPC subnet to connect to resources within a VPC. See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html.

      Mutually exclusive with vpc: provide subnet to pin the connection to a specific subnet, or provide vpc (optionally with vpcSubnets) to let the CDK select one for you.

      Default: - no subnet, unless `vpc` is provided

      Parameters:
      subnet - The VPC subnet to connect to resources within a VPC. See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html. This parameter is required.
      Returns:
      this

    • vpc

      @Stability(Experimental) public Connection.Builder vpc(IVpc vpc)
      (experimental) The VPC to connect to resources within.

      When provided, the CDK selects a subnet from this VPC using vpcSubnets. A Glue connection targets a single subnet, so the first subnet of the selection is used.

      Mutually exclusive with subnet.

      Default: - no VPC, the subnet is taken from `subnet` if provided

      Parameters:
      vpc - The VPC to connect to resources within. This parameter is required.
      Returns:
      this

    • vpcSubnets

      @Stability(Experimental) public Connection.Builder vpcSubnets(SubnetSelection vpcSubnets)
      (experimental) Which subnets of vpc to select the connection subnet from.

      Only used when vpc is provided. Since a Glue connection targets a single subnet, the first subnet of the selection is used.

      Default: - private subnets

      Parameters:
      vpcSubnets - Which subnets of vpc to select the connection subnet from. This parameter is required.
      Returns:
      this

    • type

      @Stability(Experimental) public Connection.Builder type(ConnectionType type)
      (experimental) The type of the connection.

      Parameters:
      type - The type of the connection. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public Connection build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Connection>
      Returns:
      a newly built instance of Connection.