Alibaba Cloud v3.37.0, May 15 23

alicloud.pvtz.Endpoint

Explore with Pulumi AI

Provides a Private Zone Endpoint resource.

For information about Private Zone Endpoint and how to use it, see What is Endpoint.

NOTE: Available in v1.143.0+.

Create Endpoint Resource

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);

@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             endpoint_name: Optional[str] = None,
             ip_configs: Optional[Sequence[EndpointIpConfigArgs]] = None,
             security_group_id: Optional[str] = None,
             vpc_id: Optional[str] = None,
             vpc_region_id: Optional[str] = None)
@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)

public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)

type: alicloud:pvtz:Endpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: 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 EndpointArgs: 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 EndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Endpoint 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 Endpoint resource accepts the following input properties:

EndpointName string: The name of the resource.
IpConfigs List<Pulumi.AliCloud.Pvtz.Inputs.EndpointIpConfigArgs>: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
SecurityGroupId string: The ID of the Security Group.
VpcId string: The VPC ID.
VpcRegionId string: The Region of the VPC.

EndpointName string: The name of the resource.
IpConfigs []EndpointIpConfigArgs: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
SecurityGroupId string: The ID of the Security Group.
VpcId string: The VPC ID.
VpcRegionId string: The Region of the VPC.

endpointName String: The name of the resource.
ipConfigs List<EndpointIpConfigArgs>: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
securityGroupId String: The ID of the Security Group.
vpcId String: The VPC ID.
vpcRegionId String: The Region of the VPC.

endpointName string: The name of the resource.
ipConfigs EndpointIpConfigArgs[]: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
securityGroupId string: The ID of the Security Group.
vpcId string: The VPC ID.
vpcRegionId string: The Region of the VPC.

endpoint_name str: The name of the resource.
ip_configs Sequence[EndpointIpConfigArgs]: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
security_group_id str: The ID of the Security Group.
vpc_id str: The VPC ID.
vpc_region_id str: The Region of the VPC.

endpointName String: The name of the resource.
ipConfigs List<Property Map>: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
securityGroupId String: The ID of the Security Group.
vpcId String: The VPC ID.
vpcRegionId String: The Region of the VPC.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.

Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.

id String: The provider-assigned unique ID for this managed resource.
status String: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.

id string: The provider-assigned unique ID for this managed resource.
status string: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.

id str: The provider-assigned unique ID for this managed resource.
status str: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.

id String: The provider-assigned unique ID for this managed resource.
status String: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.

Look up Existing Endpoint Resource

Get an existing Endpoint 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?: EndpointState, opts?: CustomResourceOptions): Endpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        endpoint_name: Optional[str] = None,
        ip_configs: Optional[Sequence[EndpointIpConfigArgs]] = None,
        security_group_id: Optional[str] = None,
        status: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_region_id: Optional[str] = None) -> Endpoint

func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)

public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)

public static Endpoint get(String name, Output<String> id, EndpointState 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:

EndpointName string: The name of the resource.
IpConfigs List<Pulumi.AliCloud.Pvtz.Inputs.EndpointIpConfigArgs>: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
SecurityGroupId string: The ID of the Security Group.
Status string: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.
VpcId string: The VPC ID.
VpcRegionId string: The Region of the VPC.

EndpointName string: The name of the resource.
IpConfigs []EndpointIpConfigArgs: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
SecurityGroupId string: The ID of the Security Group.
Status string: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.
VpcId string: The VPC ID.
VpcRegionId string: The Region of the VPC.

endpointName String: The name of the resource.
ipConfigs List<EndpointIpConfigArgs>: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
securityGroupId String: The ID of the Security Group.
status String: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.
vpcId String: The VPC ID.
vpcRegionId String: The Region of the VPC.

endpointName string: The name of the resource.
ipConfigs EndpointIpConfigArgs[]: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
securityGroupId string: The ID of the Security Group.
status string: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.
vpcId string: The VPC ID.
vpcRegionId string: The Region of the VPC.

endpoint_name str: The name of the resource.
ip_configs Sequence[EndpointIpConfigArgs]: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
security_group_id str: The ID of the Security Group.
status str: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.
vpc_id str: The VPC ID.
vpc_region_id str: The Region of the VPC.

endpointName String: The name of the resource.
ipConfigs List<Property Map>: The Ip Configs. See the following Block ip_configs. NOTE: In order to ensure high availability, add at least 2 and up to 6.
securityGroupId String: The ID of the Security Group.
status String: The status of the resource. Valid values: CHANGE_FAILED, CHANGE_INIT, EXCEPTION, FAILED, INIT, SUCCESS.
vpcId String: The VPC ID.
vpcRegionId String: The Region of the VPC.

Supporting Types

EndpointIpConfig

CidrBlock string: The Subnet mask.
VswitchId string: The Vswitch id.
ZoneId string: The Zone ID.
Ip string: The IP address within the parameter range of the subnet mask. It is recommended to use the IP address assigned by the system.

CidrBlock string: The Subnet mask.
VswitchId string: The Vswitch id.
ZoneId string: The Zone ID.
Ip string: The IP address within the parameter range of the subnet mask. It is recommended to use the IP address assigned by the system.

cidrBlock String: The Subnet mask.
vswitchId String: The Vswitch id.
zoneId String: The Zone ID.
ip String: The IP address within the parameter range of the subnet mask. It is recommended to use the IP address assigned by the system.

cidrBlock string: The Subnet mask.
vswitchId string: The Vswitch id.
zoneId string: The Zone ID.
ip string: The IP address within the parameter range of the subnet mask. It is recommended to use the IP address assigned by the system.

cidr_block str: The Subnet mask.
vswitch_id str: The Vswitch id.
zone_id str: The Zone ID.
ip str: The IP address within the parameter range of the subnet mask. It is recommended to use the IP address assigned by the system.

cidrBlock String: The Subnet mask.
vswitchId String: The Vswitch id.
zoneId String: The Zone ID.
ip String: The IP address within the parameter range of the subnet mask. It is recommended to use the IP address assigned by the system.

Import

Private Zone Endpoint can be imported using the id, e.g.

 $ pulumi import alicloud:pvtz/endpoint:Endpoint example <id>

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.