Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/alpha
  6. getPublicDelegatedPrefix

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.compute/alpha.getPublicDelegatedPrefix

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Returns the specified PublicDelegatedPrefix resource in the given region.

    Using getPublicDelegatedPrefix

    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 getPublicDelegatedPrefix(args: GetPublicDelegatedPrefixArgs, opts?: InvokeOptions): Promise<GetPublicDelegatedPrefixResult>
function getPublicDelegatedPrefixOutput(args: GetPublicDelegatedPrefixOutputArgs, opts?: InvokeOptions): Output<GetPublicDelegatedPrefixResult>
    def get_public_delegated_prefix(project: Optional[str] = None,
                                public_delegated_prefix: Optional[str] = None,
                                region: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetPublicDelegatedPrefixResult
def get_public_delegated_prefix_output(project: Optional[pulumi.Input[str]] = None,
                                public_delegated_prefix: Optional[pulumi.Input[str]] = None,
                                region: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetPublicDelegatedPrefixResult]
    func LookupPublicDelegatedPrefix(ctx *Context, args *LookupPublicDelegatedPrefixArgs, opts ...InvokeOption) (*LookupPublicDelegatedPrefixResult, error)
func LookupPublicDelegatedPrefixOutput(ctx *Context, args *LookupPublicDelegatedPrefixOutputArgs, opts ...InvokeOption) LookupPublicDelegatedPrefixResultOutput

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

    public static class GetPublicDelegatedPrefix 
{
    public static Task<GetPublicDelegatedPrefixResult> InvokeAsync(GetPublicDelegatedPrefixArgs args, InvokeOptions? opts = null)
    public static Output<GetPublicDelegatedPrefixResult> Invoke(GetPublicDelegatedPrefixInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPublicDelegatedPrefixResult> getPublicDelegatedPrefix(GetPublicDelegatedPrefixArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:compute/alpha:getPublicDelegatedPrefix
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getPublicDelegatedPrefix Result

    The following output properties are available:

    AllocatablePrefixLength int
    The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
    ByoipApiVersion string
    The version of BYOIP API.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Fingerprint string
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
    IpCidrRange string
    The IP address range, in CIDR format, represented by this public delegated prefix.
    IsLiveMigration bool
    If true, the prefix will be live migrated.
    Kind string
    Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
    Mode string
    The public delegated prefix mode for IPv6 only.
    Name string
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    ParentPrefix string
    The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
    PublicDelegatedSubPrefixs List<Pulumi.GoogleNative.Compute.Alpha.Outputs.PublicDelegatedPrefixPublicDelegatedSubPrefixResponse>
    The list of sub public delegated prefixes that exist for this public delegated prefix.
    Region string
    URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    SelfLink string
    Server-defined URL for the resource.
    SelfLinkWithId string
    Server-defined URL with id for the resource.
    Status string
    The status of the public delegated prefix, which can be one of following values: - INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet. - READY_TO_ANNOUNCE The public delegated prefix is a live migration prefix and is active. - ANNOUNCED The public delegated prefix is active. - DELETING The public delegated prefix is being deprovsioned.
    AllocatablePrefixLength int
    The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
    ByoipApiVersion string
    The version of BYOIP API.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Fingerprint string
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
    IpCidrRange string
    The IP address range, in CIDR format, represented by this public delegated prefix.
    IsLiveMigration bool
    If true, the prefix will be live migrated.
    Kind string
    Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
    Mode string
    The public delegated prefix mode for IPv6 only.
    Name string
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    ParentPrefix string
    The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
    PublicDelegatedSubPrefixs []PublicDelegatedPrefixPublicDelegatedSubPrefixResponse
    The list of sub public delegated prefixes that exist for this public delegated prefix.
    Region string
    URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    SelfLink string
    Server-defined URL for the resource.
    SelfLinkWithId string
    Server-defined URL with id for the resource.
    Status string
    The status of the public delegated prefix, which can be one of following values: - INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet. - READY_TO_ANNOUNCE The public delegated prefix is a live migration prefix and is active. - ANNOUNCED The public delegated prefix is active. - DELETING The public delegated prefix is being deprovsioned.
    allocatablePrefixLength Integer
    The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
    byoipApiVersion String
    The version of BYOIP API.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint String
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
    ipCidrRange String
    The IP address range, in CIDR format, represented by this public delegated prefix.
    isLiveMigration Boolean
    If true, the prefix will be live migrated.
    kind String
    Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
    mode String
    The public delegated prefix mode for IPv6 only.
    name String
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    parentPrefix String
    The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
    publicDelegatedSubPrefixs List<PublicDelegatedPrefixPublicDelegatedSubPrefixResponse>
    The list of sub public delegated prefixes that exist for this public delegated prefix.
    region String
    URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    selfLink String
    Server-defined URL for the resource.
    selfLinkWithId String
    Server-defined URL with id for the resource.
    status String
    The status of the public delegated prefix, which can be one of following values: - INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet. - READY_TO_ANNOUNCE The public delegated prefix is a live migration prefix and is active. - ANNOUNCED The public delegated prefix is active. - DELETING The public delegated prefix is being deprovsioned.
    allocatablePrefixLength number
    The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
    byoipApiVersion string
    The version of BYOIP API.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    description string
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint string
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
    ipCidrRange string
    The IP address range, in CIDR format, represented by this public delegated prefix.
    isLiveMigration boolean
    If true, the prefix will be live migrated.
    kind string
    Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
    mode string
    The public delegated prefix mode for IPv6 only.
    name string
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    parentPrefix string
    The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
    publicDelegatedSubPrefixs PublicDelegatedPrefixPublicDelegatedSubPrefixResponse[]
    The list of sub public delegated prefixes that exist for this public delegated prefix.
    region string
    URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    selfLink string
    Server-defined URL for the resource.
    selfLinkWithId string
    Server-defined URL with id for the resource.
    status string
    The status of the public delegated prefix, which can be one of following values: - INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet. - READY_TO_ANNOUNCE The public delegated prefix is a live migration prefix and is active. - ANNOUNCED The public delegated prefix is active. - DELETING The public delegated prefix is being deprovsioned.
    allocatable_prefix_length int
    The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
    byoip_api_version str
    The version of BYOIP API.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    description str
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint str
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
    ip_cidr_range str
    The IP address range, in CIDR format, represented by this public delegated prefix.
    is_live_migration bool
    If true, the prefix will be live migrated.
    kind str
    Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
    mode str
    The public delegated prefix mode for IPv6 only.
    name str
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    parent_prefix str
    The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
    public_delegated_sub_prefixs Sequence[PublicDelegatedPrefixPublicDelegatedSubPrefixResponse]
    The list of sub public delegated prefixes that exist for this public delegated prefix.
    region str
    URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    self_link str
    Server-defined URL for the resource.
    self_link_with_id str
    Server-defined URL with id for the resource.
    status str
    The status of the public delegated prefix, which can be one of following values: - INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet. - READY_TO_ANNOUNCE The public delegated prefix is a live migration prefix and is active. - ANNOUNCED The public delegated prefix is active. - DELETING The public delegated prefix is being deprovsioned.
    allocatablePrefixLength Number
    The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.
    byoipApiVersion String
    The version of BYOIP API.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint String
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
    ipCidrRange String
    The IP address range, in CIDR format, represented by this public delegated prefix.
    isLiveMigration Boolean
    If true, the prefix will be live migrated.
    kind String
    Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.
    mode String
    The public delegated prefix mode for IPv6 only.
    name String
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    parentPrefix String
    The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
    publicDelegatedSubPrefixs List<Property Map>
    The list of sub public delegated prefixes that exist for this public delegated prefix.
    region String
    URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    selfLink String
    Server-defined URL for the resource.
    selfLinkWithId String
    Server-defined URL with id for the resource.
    status String
    The status of the public delegated prefix, which can be one of following values: - INITIALIZING The public delegated prefix is being initialized and addresses cannot be created yet. - READY_TO_ANNOUNCE The public delegated prefix is a live migration prefix and is active. - ANNOUNCED The public delegated prefix is active. - DELETING The public delegated prefix is being deprovsioned.

    Supporting Types

    PublicDelegatedPrefixPublicDelegatedSubPrefixResponse

    AllocatablePrefixLength int
    The allocatable prefix length supported by this PublicDelegatedSubPrefix.
    DelegateeProject string
    Name of the project scoping this PublicDelegatedSubPrefix.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    IpCidrRange string
    The IP address range, in CIDR format, represented by this sub public delegated prefix.
    IsAddress bool
    Whether the sub prefix is delegated to create Address resources in the delegatee project.
    Mode string
    The PublicDelegatedSubPrefix mode for IPv6 only.
    Name string
    The name of the sub public delegated prefix.
    Region string
    The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.
    Status string
    The status of the sub public delegated prefix.
    AllocatablePrefixLength int
    The allocatable prefix length supported by this PublicDelegatedSubPrefix.
    DelegateeProject string
    Name of the project scoping this PublicDelegatedSubPrefix.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    IpCidrRange string
    The IP address range, in CIDR format, represented by this sub public delegated prefix.
    IsAddress bool
    Whether the sub prefix is delegated to create Address resources in the delegatee project.
    Mode string
    The PublicDelegatedSubPrefix mode for IPv6 only.
    Name string
    The name of the sub public delegated prefix.
    Region string
    The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.
    Status string
    The status of the sub public delegated prefix.
    allocatablePrefixLength Integer
    The allocatable prefix length supported by this PublicDelegatedSubPrefix.
    delegateeProject String
    Name of the project scoping this PublicDelegatedSubPrefix.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    ipCidrRange String
    The IP address range, in CIDR format, represented by this sub public delegated prefix.
    isAddress Boolean
    Whether the sub prefix is delegated to create Address resources in the delegatee project.
    mode String
    The PublicDelegatedSubPrefix mode for IPv6 only.
    name String
    The name of the sub public delegated prefix.
    region String
    The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.
    status String
    The status of the sub public delegated prefix.
    allocatablePrefixLength number
    The allocatable prefix length supported by this PublicDelegatedSubPrefix.
    delegateeProject string
    Name of the project scoping this PublicDelegatedSubPrefix.
    description string
    An optional description of this resource. Provide this property when you create the resource.
    ipCidrRange string
    The IP address range, in CIDR format, represented by this sub public delegated prefix.
    isAddress boolean
    Whether the sub prefix is delegated to create Address resources in the delegatee project.
    mode string
    The PublicDelegatedSubPrefix mode for IPv6 only.
    name string
    The name of the sub public delegated prefix.
    region string
    The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.
    status string
    The status of the sub public delegated prefix.
    allocatable_prefix_length int
    The allocatable prefix length supported by this PublicDelegatedSubPrefix.
    delegatee_project str
    Name of the project scoping this PublicDelegatedSubPrefix.
    description str
    An optional description of this resource. Provide this property when you create the resource.
    ip_cidr_range str
    The IP address range, in CIDR format, represented by this sub public delegated prefix.
    is_address bool
    Whether the sub prefix is delegated to create Address resources in the delegatee project.
    mode str
    The PublicDelegatedSubPrefix mode for IPv6 only.
    name str
    The name of the sub public delegated prefix.
    region str
    The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.
    status str
    The status of the sub public delegated prefix.
    allocatablePrefixLength Number
    The allocatable prefix length supported by this PublicDelegatedSubPrefix.
    delegateeProject String
    Name of the project scoping this PublicDelegatedSubPrefix.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    ipCidrRange String
    The IP address range, in CIDR format, represented by this sub public delegated prefix.
    isAddress Boolean
    Whether the sub prefix is delegated to create Address resources in the delegatee project.
    mode String
    The PublicDelegatedSubPrefix mode for IPv6 only.
    name String
    The name of the sub public delegated prefix.
    region String
    The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.
    status String
    The status of the sub public delegated prefix.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native