1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. redis
  6. getEndpointPublicAddress
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.redis.getEndpointPublicAddress

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::Redis::EndpointPublicAddress

    Using getEndpointPublicAddress

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEndpointPublicAddress(args: GetEndpointPublicAddressArgs, opts?: InvokeOptions): Promise<GetEndpointPublicAddressResult>
function getEndpointPublicAddressOutput(args: GetEndpointPublicAddressOutputArgs, opts?: InvokeOptions): Output<GetEndpointPublicAddressResult>
    def get_endpoint_public_address(id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetEndpointPublicAddressResult
def get_endpoint_public_address_output(id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetEndpointPublicAddressResult]
    func LookupEndpointPublicAddress(ctx *Context, args *LookupEndpointPublicAddressArgs, opts ...InvokeOption) (*LookupEndpointPublicAddressResult, error)
func LookupEndpointPublicAddressOutput(ctx *Context, args *LookupEndpointPublicAddressOutputArgs, opts ...InvokeOption) LookupEndpointPublicAddressResultOutput

    > Note: This function is named LookupEndpointPublicAddress in the Go SDK.

    public static class GetEndpointPublicAddress 
{
    public static Task<GetEndpointPublicAddressResult> InvokeAsync(GetEndpointPublicAddressArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointPublicAddressResult> Invoke(GetEndpointPublicAddressInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEndpointPublicAddressResult> getEndpointPublicAddress(GetEndpointPublicAddressArgs args, InvokeOptions options)
public static Output<GetEndpointPublicAddressResult> getEndpointPublicAddress(GetEndpointPublicAddressArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:redis/getEndpointPublicAddress:getEndpointPublicAddress
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getEndpointPublicAddress Result

    The following output properties are available:

    AddrType string
    Connection address type. Valid values: Private: Private network connection address. Public: Public network connection address. DirectLink: Direct connection address. Note: Direct connection address information is returned only when a sharded Redis cluster instance has applied for a direct connection address. For more information about connection address types, see Connection Address Types.
    Address string
    IP address or domain name
    EipId string
    ID of the Elastic Public IP
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    NewAddressPrefix string
    Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.
    Port int
    Port number
    UpgradeRegionDomain bool
    Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.
    ViPv6 string
    IPv6 address corresponding to the connection address. Note: This parameter is returned only if the instance uses an IPv6 address. Only private network addresses and direct connection addresses support IPv6; public network addresses do not. Therefore, when the connection address type is Public (i.e., AddrType is Public), this parameter is always empty.
    Vip string
    IPv4 address corresponding to the connection address
    AddrType string
    Connection address type. Valid values: Private: Private network connection address. Public: Public network connection address. DirectLink: Direct connection address. Note: Direct connection address information is returned only when a sharded Redis cluster instance has applied for a direct connection address. For more information about connection address types, see Connection Address Types.
    Address string
    IP address or domain name
    EipId string
    ID of the Elastic Public IP
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID
    NewAddressPrefix string
    Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.
    Port int
    Port number
    UpgradeRegionDomain bool
    Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.
    ViPv6 string
    IPv6 address corresponding to the connection address. Note: This parameter is returned only if the instance uses an IPv6 address. Only private network addresses and direct connection addresses support IPv6; public network addresses do not. Therefore, when the connection address type is Public (i.e., AddrType is Public), this parameter is always empty.
    Vip string
    IPv4 address corresponding to the connection address
    addrType String
    Connection address type. Valid values: Private: Private network connection address. Public: Public network connection address. DirectLink: Direct connection address. Note: Direct connection address information is returned only when a sharded Redis cluster instance has applied for a direct connection address. For more information about connection address types, see Connection Address Types.
    address String
    IP address or domain name
    eipId String
    ID of the Elastic Public IP
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    newAddressPrefix String
    Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.
    port Integer
    Port number
    upgradeRegionDomain Boolean
    Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.
    viPv6 String
    IPv6 address corresponding to the connection address. Note: This parameter is returned only if the instance uses an IPv6 address. Only private network addresses and direct connection addresses support IPv6; public network addresses do not. Therefore, when the connection address type is Public (i.e., AddrType is Public), this parameter is always empty.
    vip String
    IPv4 address corresponding to the connection address
    addrType string
    Connection address type. Valid values: Private: Private network connection address. Public: Public network connection address. DirectLink: Direct connection address. Note: Direct connection address information is returned only when a sharded Redis cluster instance has applied for a direct connection address. For more information about connection address types, see Connection Address Types.
    address string
    IP address or domain name
    eipId string
    ID of the Elastic Public IP
    id string
    Uniquely identifies the resource.
    instanceId string
    Instance ID
    newAddressPrefix string
    Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.
    port number
    Port number
    upgradeRegionDomain boolean
    Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.
    viPv6 string
    IPv6 address corresponding to the connection address. Note: This parameter is returned only if the instance uses an IPv6 address. Only private network addresses and direct connection addresses support IPv6; public network addresses do not. Therefore, when the connection address type is Public (i.e., AddrType is Public), this parameter is always empty.
    vip string
    IPv4 address corresponding to the connection address
    addr_type str
    Connection address type. Valid values: Private: Private network connection address. Public: Public network connection address. DirectLink: Direct connection address. Note: Direct connection address information is returned only when a sharded Redis cluster instance has applied for a direct connection address. For more information about connection address types, see Connection Address Types.
    address str
    IP address or domain name
    eip_id str
    ID of the Elastic Public IP
    id str
    Uniquely identifies the resource.
    instance_id str
    Instance ID
    new_address_prefix str
    Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.
    port int
    Port number
    upgrade_region_domain bool
    Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.
    vi_pv6 str
    IPv6 address corresponding to the connection address. Note: This parameter is returned only if the instance uses an IPv6 address. Only private network addresses and direct connection addresses support IPv6; public network addresses do not. Therefore, when the connection address type is Public (i.e., AddrType is Public), this parameter is always empty.
    vip str
    IPv4 address corresponding to the connection address
    addrType String
    Connection address type. Valid values: Private: Private network connection address. Public: Public network connection address. DirectLink: Direct connection address. Note: Direct connection address information is returned only when a sharded Redis cluster instance has applied for a direct connection address. For more information about connection address types, see Connection Address Types.
    address String
    IP address or domain name
    eipId String
    ID of the Elastic Public IP
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID
    newAddressPrefix String
    Modified connection address prefix. The connection address prefix must meet the following requirements: Consist of lowercase letters, numbers, or hyphens (-). Start with a letter and end with a letter or number. Length must be 8–53 characters. The modified connection address must be globally unique and must not duplicate any connection address in any region of Volcano Engine.
    port Number
    Port number
    upgradeRegionDomain Boolean
    Whether to upgrade the domain suffix of the connection address. Valid values: true: Upgrade. false (default): Do not upgrade. Note: When upgrading the domain suffix (i.e., UpgradeRegionDomain is true), you must also provide the connection address prefix (i.e., the Address parameter cannot be empty). After upgrading the domain suffix, existing connections will be disconnected. Please promptly update your client connection information and use the new connection address to connect to the instance. For details on connecting to an instance, see Connect to Instance. Once the domain suffix of the connection address is upgraded, it cannot be downgraded to the original suffix. Please proceed with caution. The upgraded domain suffix will automatically include the region information of the instance. The old connection address will be retained for 12 hours and will be automatically released after the retention period expires. For more details, see Upgrade Domain Suffix.
    viPv6 String
    IPv6 address corresponding to the connection address. Note: This parameter is returned only if the instance uses an IPv6 address. Only private network addresses and direct connection addresses support IPv6; public network addresses do not. Therefore, when the connection address type is Public (i.e., AddrType is Public), this parameter is always empty.
    vip String
    IPv4 address corresponding to the connection address

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.