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

Class ConnectionOptions.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • connectionName

      @Stability(Experimental) public ConnectionOptions.Builder connectionName(String connectionName)
      Sets the value of ConnectionOptions.getConnectionName()
      Parameters:
      connectionName - The name of the connection.
      Returns:
      this

    • description

      @Stability(Experimental) public ConnectionOptions.Builder description(String description)
      Sets the value of ConnectionOptions.getDescription()
      Parameters:
      description - The description of the connection.
      Returns:
      this

    • matchCriteria

      @Stability(Experimental) public ConnectionOptions.Builder matchCriteria(List<String> matchCriteria)
      Sets the value of ConnectionOptions.getMatchCriteria()
      Parameters:
      matchCriteria - 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
      Returns:
      this

    • properties

      @Stability(Experimental) public ConnectionOptions.Builder properties(Map<String,String> properties)
      Sets the value of ConnectionOptions.getProperties()
      Parameters:
      properties - Key-Value pairs that define parameters for the connection.
      Returns:
      this

    • secret

      @Stability(Experimental) public ConnectionOptions.Builder secret(ISecretRef secret)
      Sets the value of ConnectionOptions.getSecret()
      Parameters:
      secret - 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.
      Returns:
      this

    • securityGroups

      @Stability(Experimental) public ConnectionOptions.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
      Sets the value of ConnectionOptions.getSecurityGroups()
      Parameters:
      securityGroups - The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.
      Returns:
      this

    • subnet

      @Stability(Experimental) public ConnectionOptions.Builder subnet(ISubnet subnet)
      Sets the value of ConnectionOptions.getSubnet()
      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. 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.
      Returns:
      this

    • vpc

      @Stability(Experimental) public ConnectionOptions.Builder vpc(IVpc vpc)
      Sets the value of ConnectionOptions.getVpc()
      Parameters:
      vpc - 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.

      Returns:
      this

    • vpcSubnets

      @Stability(Experimental) public ConnectionOptions.Builder vpcSubnets(SubnetSelection vpcSubnets)
      Sets the value of ConnectionOptions.getVpcSubnets()
      Parameters:
      vpcSubnets - 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.
      Returns:
      this

    • build

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