public_advertised_prefixes

Creates, updates, deletes, gets or lists a public_advertised_prefixes resource.

Overview

Name	public_advertised_prefixes
Type	Resource
Id	google.compute.public_advertised_prefixes

Fields

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource type. The server generates this identifier.
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.
description	string	An optional description of this resource. Provide this property when you create the resource.
byoipApiVersion	string	[Output Only] The version of BYOIP API.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
dnsVerificationIp	string	The address to be used for reverse DNS verification.
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 PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
ipCidrRange	string	The address range, in CIDR format, represented by this public advertised prefix.
kind	string	[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
pdpScope	string	Specifies how child public delegated prefix will be scoped. It could be one of following values: - REGIONAL: The public delegated prefix is regional only. The provisioning will take a few minutes. - GLOBAL: The public delegated prefix is global only. The provisioning will take ~4 weeks. - GLOBAL_AND_REGIONAL [output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2.
publicDelegatedPrefixs	array	[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
selfLink	string	[Output Only] Server-defined URL for the resource.
sharedSecret	string	[Output Only] The shared secret to be used for reverse DNS verification.
status	string	The status of the public advertised prefix. Possible values include: - INITIAL: RPKI validation is complete. - PTR_CONFIGURED: User has configured the PTR. - VALIDATED: Reverse DNS lookup is successful. - REVERSE_DNS_LOOKUP_FAILED: Reverse DNS lookup failed. - PREFIX_CONFIGURATION_IN_PROGRESS: The prefix is being configured. - PREFIX_CONFIGURATION_COMPLETE: The prefix is fully configured. - PREFIX_REMOVAL_IN_PROGRESS: The prefix is being removed.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	project, publicAdvertisedPrefix	Returns the specified PublicAdvertisedPrefix resource.
list	SELECT	project	Lists the PublicAdvertisedPrefixes for a project.
insert	INSERT	project	Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
delete	DELETE	project, publicAdvertisedPrefix	Deletes the specified PublicAdvertisedPrefix
patch	UPDATE	project, publicAdvertisedPrefix	Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
announce	EXEC	project, publicAdvertisedPrefix	Announces the specified PublicAdvertisedPrefix
withdraw	EXEC	project, publicAdvertisedPrefix	Withdraws the specified PublicAdvertisedPrefix

SELECT examples

Lists the PublicAdvertisedPrefixes for a project.

SELECT
id,
name,
description,
byoipApiVersion,
creationTimestamp,
dnsVerificationIp,
fingerprint,
ipCidrRange,
kind,
pdpScope,
publicDelegatedPrefixs,
selfLink,
sharedSecret,
status
FROM google.compute.public_advertised_prefixes
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new public_advertised_prefixes resource.

All Properties

/*+ create */
INSERT INTO google.compute.public_advertised_prefixes (
project,
name,
description,
ipCidrRange,
dnsVerificationIp,
sharedSecret,
status,
pdpScope,
publicDelegatedPrefixs,
fingerprint,
byoipApiVersion
)
SELECT 
'{{ project }}',
'{{ name }}',
'{{ description }}',
'{{ ipCidrRange }}',
'{{ dnsVerificationIp }}',
'{{ sharedSecret }}',
'{{ status }}',
'{{ pdpScope }}',
'{{ publicDelegatedPrefixs }}',
'{{ fingerprint }}',
'{{ byoipApiVersion }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: selfLink
      value: string
    - name: ipCidrRange
      value: string
    - name: dnsVerificationIp
      value: string
    - name: sharedSecret
      value: string
    - name: status
      value: string
    - name: pdpScope
      value: string
    - name: publicDelegatedPrefixs
      value:
        - - name: name
            value: string
          - name: region
            value: string
          - name: project
            value: string
          - name: status
            value: string
          - name: ipRange
            value: string
    - name: fingerprint
      value: string
    - name: byoipApiVersion
      value: string

UPDATE example

Updates a public_advertised_prefixes resource.

/*+ update */
UPDATE google.compute.public_advertised_prefixes
SET 
name = '{{ name }}',
description = '{{ description }}',
ipCidrRange = '{{ ipCidrRange }}',
dnsVerificationIp = '{{ dnsVerificationIp }}',
sharedSecret = '{{ sharedSecret }}',
status = '{{ status }}',
pdpScope = '{{ pdpScope }}',
publicDelegatedPrefixs = '{{ publicDelegatedPrefixs }}',
fingerprint = '{{ fingerprint }}',
byoipApiVersion = '{{ byoipApiVersion }}'
WHERE 
project = '{{ project }}'
AND publicAdvertisedPrefix = '{{ publicAdvertisedPrefix }}';

DELETE example

Deletes the specified public_advertised_prefixes resource.

/*+ delete */
DELETE FROM google.compute.public_advertised_prefixes
WHERE project = '{{ project }}'
AND publicAdvertisedPrefix = '{{ publicAdvertisedPrefix }}';