Package software.amazon.awssdk.services.finspace.model

Interface KxEnvironment.Builder

    • Method Detail

      • name

        KxEnvironment.Builder name​(String name)

        The name of the kdb environment.

        Parameters:
        name - The name of the kdb environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environmentId

        KxEnvironment.Builder environmentId​(String environmentId)

        A unique identifier for the kdb environment.

        Parameters:
        environmentId - A unique identifier for the kdb environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • awsAccountId

        KxEnvironment.Builder awsAccountId​(String awsAccountId)

        The unique identifier of the AWS account in which you create the kdb environment.

        Parameters:
        awsAccountId - The unique identifier of the AWS account in which you create the kdb environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        KxEnvironment.Builder status​(String status)

        The status of the environment creation.

        • CREATE_REQUESTED – Environment creation has been requested.

        • CREATING – Environment is in the process of being created.

        • FAILED_CREATION – Environment creation has failed.

        • CREATED – Environment is successfully created and is currently active.

        • DELETE REQUESTED – Environment deletion has been requested.

        • DELETING – Environment is in the process of being deleted.

        • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

        • DELETED – Environment has been deleted.

        • FAILED_DELETION – Environment deletion has failed.

        Parameters:
        status - The status of the environment creation.

        • CREATE_REQUESTED – Environment creation has been requested.

        • CREATING – Environment is in the process of being created.

        • FAILED_CREATION – Environment creation has failed.

        • CREATED – Environment is successfully created and is currently active.

        • DELETE REQUESTED – Environment deletion has been requested.

        • DELETING – Environment is in the process of being deleted.

        • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

        • DELETED – Environment has been deleted.

        • FAILED_DELETION – Environment deletion has failed.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnvironmentStatus, EnvironmentStatus

      • status

        KxEnvironment.Builder status​(EnvironmentStatus status)

        The status of the environment creation.

        • CREATE_REQUESTED – Environment creation has been requested.

        • CREATING – Environment is in the process of being created.

        • FAILED_CREATION – Environment creation has failed.

        • CREATED – Environment is successfully created and is currently active.

        • DELETE REQUESTED – Environment deletion has been requested.

        • DELETING – Environment is in the process of being deleted.

        • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

        • DELETED – Environment has been deleted.

        • FAILED_DELETION – Environment deletion has failed.

        Parameters:
        status - The status of the environment creation.

        • CREATE_REQUESTED – Environment creation has been requested.

        • CREATING – Environment is in the process of being created.

        • FAILED_CREATION – Environment creation has failed.

        • CREATED – Environment is successfully created and is currently active.

        • DELETE REQUESTED – Environment deletion has been requested.

        • DELETING – Environment is in the process of being deleted.

        • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

        • DELETED – Environment has been deleted.

        • FAILED_DELETION – Environment deletion has failed.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnvironmentStatus, EnvironmentStatus

      • tgwStatus

        KxEnvironment.Builder tgwStatus​(String tgwStatus)

        The status of the network configuration.

        Parameters:
        tgwStatus - The status of the network configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TgwStatus, TgwStatus

      • tgwStatus

        KxEnvironment.Builder tgwStatus​(TgwStatus tgwStatus)

        The status of the network configuration.

        Parameters:
        tgwStatus - The status of the network configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TgwStatus, TgwStatus

      • dnsStatus

        KxEnvironment.Builder dnsStatus​(String dnsStatus)

        The status of DNS configuration.

        Parameters:
        dnsStatus - The status of DNS configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DnsStatus, DnsStatus

      • dnsStatus

        KxEnvironment.Builder dnsStatus​(DnsStatus dnsStatus)

        The status of DNS configuration.

        Parameters:
        dnsStatus - The status of DNS configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DnsStatus, DnsStatus

      • errorMessage

        KxEnvironment.Builder errorMessage​(String errorMessage)

        Specifies the error message that appears if a flow fails.

        Parameters:
        errorMessage - Specifies the error message that appears if a flow fails.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        KxEnvironment.Builder description​(String description)

        A description of the kdb environment.

        Parameters:
        description - A description of the kdb environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environmentArn

        KxEnvironment.Builder environmentArn​(String environmentArn)

        The Amazon Resource Name (ARN) of your kdb environment.

        Parameters:
        environmentArn - The Amazon Resource Name (ARN) of your kdb environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        KxEnvironment.Builder kmsKeyId​(String kmsKeyId)

        The unique identifier of the KMS key.

        Parameters:
        kmsKeyId - The unique identifier of the KMS key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dedicatedServiceAccountId

        KxEnvironment.Builder dedicatedServiceAccountId​(String dedicatedServiceAccountId)

        A unique identifier for the AWS environment infrastructure account.

        Parameters:
        dedicatedServiceAccountId - A unique identifier for the AWS environment infrastructure account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • transitGatewayConfiguration

        KxEnvironment.Builder transitGatewayConfiguration​(TransitGatewayConfiguration transitGatewayConfiguration)

        Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

        Parameters:
        transitGatewayConfiguration - Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customDNSConfiguration

        KxEnvironment.Builder customDNSConfiguration​(Collection<CustomDNSServer> customDNSConfiguration)

        A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

        Parameters:
        customDNSConfiguration - A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customDNSConfiguration

        KxEnvironment.Builder customDNSConfiguration​(CustomDNSServer... customDNSConfiguration)

        A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

        Parameters:
        customDNSConfiguration - A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customDNSConfiguration

        KxEnvironment.Builder customDNSConfiguration​(Consumer<CustomDNSServer.Builder>... customDNSConfiguration)

        A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

        This is a convenience method that creates an instance of the CustomDNSServer.Builder avoiding the need to create one manually via CustomDNSServer.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #customDNSConfiguration(List).

        Parameters:
        customDNSConfiguration - a consumer that will call methods on CustomDNSServer.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #customDNSConfiguration(java.util.Collection)

      • creationTimestamp

        KxEnvironment.Builder creationTimestamp​(Instant creationTimestamp)

        The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

        Parameters:
        creationTimestamp - The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • updateTimestamp

        KxEnvironment.Builder updateTimestamp​(Instant updateTimestamp)

        The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

        Parameters:
        updateTimestamp - The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZoneIds

        KxEnvironment.Builder availabilityZoneIds​(Collection<String> availabilityZoneIds)

        The identifier of the availability zones where subnets for the environment are created.

        Parameters:
        availabilityZoneIds - The identifier of the availability zones where subnets for the environment are created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZoneIds

        KxEnvironment.Builder availabilityZoneIds​(String... availabilityZoneIds)

        The identifier of the availability zones where subnets for the environment are created.

        Parameters:
        availabilityZoneIds - The identifier of the availability zones where subnets for the environment are created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • certificateAuthorityArn

        KxEnvironment.Builder certificateAuthorityArn​(String certificateAuthorityArn)

        The Amazon Resource Name (ARN) of the certificate authority:

        Parameters:
        certificateAuthorityArn - The Amazon Resource Name (ARN) of the certificate authority:
        Returns:
        Returns a reference to this object so that method calls can be chained together.