1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. rds
  5. DbInstanceEndpointAddress
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi

alicloud.rds.DbInstanceEndpointAddress

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi

    Provide RDS cluster instance endpoint public connection resources.

    Information about RDS MySQL cluster endpoint address and how to use it, see What is RDS DB Instance Endpoint Address.

    NOTE: Available since v1.204.0.

    Create DbInstanceEndpointAddress Resource

    new DbInstanceEndpointAddress(name: string, args: DbInstanceEndpointAddressArgs, opts?: CustomResourceOptions);
    @overload
    def DbInstanceEndpointAddress(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  connection_string_prefix: Optional[str] = None,
                                  db_instance_endpoint_id: Optional[str] = None,
                                  db_instance_id: Optional[str] = None,
                                  port: Optional[str] = None)
    @overload
    def DbInstanceEndpointAddress(resource_name: str,
                                  args: DbInstanceEndpointAddressArgs,
                                  opts: Optional[ResourceOptions] = None)
    func NewDbInstanceEndpointAddress(ctx *Context, name string, args DbInstanceEndpointAddressArgs, opts ...ResourceOption) (*DbInstanceEndpointAddress, error)
    public DbInstanceEndpointAddress(string name, DbInstanceEndpointAddressArgs args, CustomResourceOptions? opts = null)
    public DbInstanceEndpointAddress(String name, DbInstanceEndpointAddressArgs args)
    public DbInstanceEndpointAddress(String name, DbInstanceEndpointAddressArgs args, CustomResourceOptions options)
    
    type: alicloud:rds:DbInstanceEndpointAddress
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DbInstanceEndpointAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DbInstanceEndpointAddressArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DbInstanceEndpointAddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbInstanceEndpointAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbInstanceEndpointAddressArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DbInstanceEndpointAddress Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DbInstanceEndpointAddress resource accepts the following input properties:

    ConnectionStringPrefix string

    The prefix of the public endpoint.

    DbInstanceEndpointId string

    The Endpoint ID of the instance.

    DbInstanceId string

    The ID of the instance.

    Port string

    The port number of the public endpoint.

    ConnectionStringPrefix string

    The prefix of the public endpoint.

    DbInstanceEndpointId string

    The Endpoint ID of the instance.

    DbInstanceId string

    The ID of the instance.

    Port string

    The port number of the public endpoint.

    connectionStringPrefix String

    The prefix of the public endpoint.

    dbInstanceEndpointId String

    The Endpoint ID of the instance.

    dbInstanceId String

    The ID of the instance.

    port String

    The port number of the public endpoint.

    connectionStringPrefix string

    The prefix of the public endpoint.

    dbInstanceEndpointId string

    The Endpoint ID of the instance.

    dbInstanceId string

    The ID of the instance.

    port string

    The port number of the public endpoint.

    connection_string_prefix str

    The prefix of the public endpoint.

    db_instance_endpoint_id str

    The Endpoint ID of the instance.

    db_instance_id str

    The ID of the instance.

    port str

    The port number of the public endpoint.

    connectionStringPrefix String

    The prefix of the public endpoint.

    dbInstanceEndpointId String

    The Endpoint ID of the instance.

    dbInstanceId String

    The ID of the instance.

    port String

    The port number of the public endpoint.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DbInstanceEndpointAddress resource produces the following output properties:

    ConnectionString string

    The endpoint of the instance.

    Id string

    The provider-assigned unique ID for this managed resource.

    IpAddress string

    The IP address of the endpoint.

    IpType string

    The type of the IP address.

    ConnectionString string

    The endpoint of the instance.

    Id string

    The provider-assigned unique ID for this managed resource.

    IpAddress string

    The IP address of the endpoint.

    IpType string

    The type of the IP address.

    connectionString String

    The endpoint of the instance.

    id String

    The provider-assigned unique ID for this managed resource.

    ipAddress String

    The IP address of the endpoint.

    ipType String

    The type of the IP address.

    connectionString string

    The endpoint of the instance.

    id string

    The provider-assigned unique ID for this managed resource.

    ipAddress string

    The IP address of the endpoint.

    ipType string

    The type of the IP address.

    connection_string str

    The endpoint of the instance.

    id str

    The provider-assigned unique ID for this managed resource.

    ip_address str

    The IP address of the endpoint.

    ip_type str

    The type of the IP address.

    connectionString String

    The endpoint of the instance.

    id String

    The provider-assigned unique ID for this managed resource.

    ipAddress String

    The IP address of the endpoint.

    ipType String

    The type of the IP address.

    Look up Existing DbInstanceEndpointAddress Resource

    Get an existing DbInstanceEndpointAddress resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DbInstanceEndpointAddressState, opts?: CustomResourceOptions): DbInstanceEndpointAddress
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            connection_string: Optional[str] = None,
            connection_string_prefix: Optional[str] = None,
            db_instance_endpoint_id: Optional[str] = None,
            db_instance_id: Optional[str] = None,
            ip_address: Optional[str] = None,
            ip_type: Optional[str] = None,
            port: Optional[str] = None) -> DbInstanceEndpointAddress
    func GetDbInstanceEndpointAddress(ctx *Context, name string, id IDInput, state *DbInstanceEndpointAddressState, opts ...ResourceOption) (*DbInstanceEndpointAddress, error)
    public static DbInstanceEndpointAddress Get(string name, Input<string> id, DbInstanceEndpointAddressState? state, CustomResourceOptions? opts = null)
    public static DbInstanceEndpointAddress get(String name, Output<String> id, DbInstanceEndpointAddressState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ConnectionString string

    The endpoint of the instance.

    ConnectionStringPrefix string

    The prefix of the public endpoint.

    DbInstanceEndpointId string

    The Endpoint ID of the instance.

    DbInstanceId string

    The ID of the instance.

    IpAddress string

    The IP address of the endpoint.

    IpType string

    The type of the IP address.

    Port string

    The port number of the public endpoint.

    ConnectionString string

    The endpoint of the instance.

    ConnectionStringPrefix string

    The prefix of the public endpoint.

    DbInstanceEndpointId string

    The Endpoint ID of the instance.

    DbInstanceId string

    The ID of the instance.

    IpAddress string

    The IP address of the endpoint.

    IpType string

    The type of the IP address.

    Port string

    The port number of the public endpoint.

    connectionString String

    The endpoint of the instance.

    connectionStringPrefix String

    The prefix of the public endpoint.

    dbInstanceEndpointId String

    The Endpoint ID of the instance.

    dbInstanceId String

    The ID of the instance.

    ipAddress String

    The IP address of the endpoint.

    ipType String

    The type of the IP address.

    port String

    The port number of the public endpoint.

    connectionString string

    The endpoint of the instance.

    connectionStringPrefix string

    The prefix of the public endpoint.

    dbInstanceEndpointId string

    The Endpoint ID of the instance.

    dbInstanceId string

    The ID of the instance.

    ipAddress string

    The IP address of the endpoint.

    ipType string

    The type of the IP address.

    port string

    The port number of the public endpoint.

    connection_string str

    The endpoint of the instance.

    connection_string_prefix str

    The prefix of the public endpoint.

    db_instance_endpoint_id str

    The Endpoint ID of the instance.

    db_instance_id str

    The ID of the instance.

    ip_address str

    The IP address of the endpoint.

    ip_type str

    The type of the IP address.

    port str

    The port number of the public endpoint.

    connectionString String

    The endpoint of the instance.

    connectionStringPrefix String

    The prefix of the public endpoint.

    dbInstanceEndpointId String

    The Endpoint ID of the instance.

    dbInstanceId String

    The ID of the instance.

    ipAddress String

    The IP address of the endpoint.

    ipType String

    The type of the IP address.

    port String

    The port number of the public endpoint.

    Import

    RDS database endpoint public address feature can be imported using the id, e.g.

     $ pulumi import alicloud:rds/dbInstanceEndpointAddress:DbInstanceEndpointAddress example <db_instance_id>:<db_instance_endpoint_id>
    

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the alicloud Terraform Provider.

    alicloud logo
    Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi