{ "description": "VPCIpamPool is the Schema for the VPCIpamPools API. Provides a IP address pool resource for IPAM.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "VPCIpamPoolSpec defines the desired state of VPCIpamPool", "properties": { "forProvider": { "properties": { "addressFamily": { "description": "The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.", "type": "string" }, "allocationDefaultNetmaskLength": { "description": "A default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16 (unless you provide a different netmask value when you create the new allocation).", "type": "number" }, "allocationMaxNetmaskLength": { "description": "The maximum netmask length that will be required for CIDR allocations in this pool.", "type": "number" }, "allocationMinNetmaskLength": { "description": "The minimum netmask length that will be required for CIDR allocations in this pool.", "type": "number" }, "allocationResourceTags": { "additionalProperties": { "type": "string" }, "description": "Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.", "type": "object", "x-kubernetes-map-type": "granular" }, "autoImport": { "description": "If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall\nwithin the CIDR range in the pool.", "type": "boolean" }, "awsService": { "description": "Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.", "type": "string" }, "cascade": { "description": "Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.", "type": "boolean" }, "description": { "description": "A description for the IPAM pool.", "type": "string" }, "ipamScopeId": { "description": "The ID of the scope in which you would like to create the IPAM pool.", "type": "string" }, "ipamScopeIdRef": { "description": "Reference to a VPCIpamScope in ec2 to populate ipamScopeId.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "namespace": { "description": "Namespace of the referenced object", "type": "string" }, "policy": { "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "ipamScopeIdSelector": { "description": "Selector for a VPCIpamScope in ec2 to populate ipamScopeId.", "properties": { "matchControllerRef": { "description": "MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected.", "type": "boolean" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "MatchLabels ensures an object with matching labels is selected.", "type": "object" }, "namespace": { "description": "Namespace for the selector", "type": "string" }, "policy": { "description": "Policies for selection.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "locale": { "description": "The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.", "type": "string" }, "publicIpSource": { "description": "The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.", "type": "string" }, "publiclyAdvertisable": { "description": "Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = \"ipv6\" and public_ip_source = \"byoip\", default is false. This option is not available for IPv4 pool space or if public_ip_source = \"amazon\". Setting this argument to true when it is not available may result in erroneous differences being reported.", "type": "boolean" }, "region": { "description": "Region where this resource will be managed. Defaults to the Region set in the provider configuration.\nRegion is the region you'd like your resource to be created in.", "type": "string" }, "sourceIpamPoolId": { "description": "The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.", "type": "string" }, "sourceIpamPoolIdRef": { "description": "Reference to a VPCIpamPool in ec2 to populate sourceIpamPoolId.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "namespace": { "description": "Namespace of the referenced object", "type": "string" }, "policy": { "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "sourceIpamPoolIdSelector": { "description": "Selector for a VPCIpamPool in ec2 to populate sourceIpamPoolId.", "properties": { "matchControllerRef": { "description": "MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected.", "type": "boolean" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "MatchLabels ensures an object with matching labels is selected.", "type": "object" }, "namespace": { "description": "Namespace for the selector", "type": "string" }, "policy": { "description": "Policies for selection.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "tags": { "additionalProperties": { "type": "string" }, "description": "Key-value map of resource tags.", "type": "object", "x-kubernetes-map-type": "granular" } }, "required": [ "region" ], "type": "object", "additionalProperties": false }, "initProvider": { "description": "THIS IS A BETA FIELD. It will be honored\nunless the Management Policies feature flag is disabled.\nInitProvider holds the same fields as ForProvider, with the exception\nof Identifier and other resource reference fields. The fields that are\nin InitProvider are merged into ForProvider when the resource is created.\nThe same fields are also added to the terraform ignore_changes hook, to\navoid updating them after creation. This is useful for fields that are\nrequired on creation, but we do not desire to update them after creation,\nfor example because of an external controller is managing them, like an\nautoscaler.", "properties": { "addressFamily": { "description": "The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.", "type": "string" }, "allocationDefaultNetmaskLength": { "description": "A default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16 (unless you provide a different netmask value when you create the new allocation).", "type": "number" }, "allocationMaxNetmaskLength": { "description": "The maximum netmask length that will be required for CIDR allocations in this pool.", "type": "number" }, "allocationMinNetmaskLength": { "description": "The minimum netmask length that will be required for CIDR allocations in this pool.", "type": "number" }, "allocationResourceTags": { "additionalProperties": { "type": "string" }, "description": "Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.", "type": "object", "x-kubernetes-map-type": "granular" }, "autoImport": { "description": "If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall\nwithin the CIDR range in the pool.", "type": "boolean" }, "awsService": { "description": "Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.", "type": "string" }, "cascade": { "description": "Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.", "type": "boolean" }, "description": { "description": "A description for the IPAM pool.", "type": "string" }, "ipamScopeId": { "description": "The ID of the scope in which you would like to create the IPAM pool.", "type": "string" }, "ipamScopeIdRef": { "description": "Reference to a VPCIpamScope in ec2 to populate ipamScopeId.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "namespace": { "description": "Namespace of the referenced object", "type": "string" }, "policy": { "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "ipamScopeIdSelector": { "description": "Selector for a VPCIpamScope in ec2 to populate ipamScopeId.", "properties": { "matchControllerRef": { "description": "MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected.", "type": "boolean" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "MatchLabels ensures an object with matching labels is selected.", "type": "object" }, "namespace": { "description": "Namespace for the selector", "type": "string" }, "policy": { "description": "Policies for selection.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "locale": { "description": "The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.", "type": "string" }, "publicIpSource": { "description": "The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.", "type": "string" }, "publiclyAdvertisable": { "description": "Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = \"ipv6\" and public_ip_source = \"byoip\", default is false. This option is not available for IPv4 pool space or if public_ip_source = \"amazon\". Setting this argument to true when it is not available may result in erroneous differences being reported.", "type": "boolean" }, "sourceIpamPoolId": { "description": "The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.", "type": "string" }, "sourceIpamPoolIdRef": { "description": "Reference to a VPCIpamPool in ec2 to populate sourceIpamPoolId.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "namespace": { "description": "Namespace of the referenced object", "type": "string" }, "policy": { "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "sourceIpamPoolIdSelector": { "description": "Selector for a VPCIpamPool in ec2 to populate sourceIpamPoolId.", "properties": { "matchControllerRef": { "description": "MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected.", "type": "boolean" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "MatchLabels ensures an object with matching labels is selected.", "type": "object" }, "namespace": { "description": "Namespace for the selector", "type": "string" }, "policy": { "description": "Policies for selection.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "tags": { "additionalProperties": { "type": "string" }, "description": "Key-value map of resource tags.", "type": "object", "x-kubernetes-map-type": "granular" } }, "type": "object", "additionalProperties": false }, "managementPolicies": { "default": [ "*" ], "description": "THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md", "items": { "description": "A ManagementAction represents an action that the Crossplane controllers\ncan take on an external resource.", "enum": [ "Observe", "Create", "Update", "Delete", "LateInitialize", "*" ], "type": "string" }, "type": "array" }, "providerConfigRef": { "default": { "kind": "ClusterProviderConfig", "name": "default" }, "description": "ProviderConfigReference specifies how the provider that will be used to\ncreate, observe, update, and delete this managed resource should be\nconfigured.", "properties": { "kind": { "description": "Kind of the referenced object.", "type": "string" }, "name": { "description": "Name of the referenced object.", "type": "string" } }, "required": [ "kind", "name" ], "type": "object", "additionalProperties": false }, "writeConnectionSecretToRef": { "description": "WriteConnectionSecretToReference specifies the namespace and name of a\nSecret to which any connection details for this managed resource should\nbe written. Connection details frequently include the endpoint, username,\nand password required to connect to the managed resource.", "properties": { "name": { "description": "Name of the secret.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false } }, "required": [ "forProvider" ], "type": "object", "x-kubernetes-validations": [ { "message": "spec.forProvider.addressFamily is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.addressFamily) || (has(self.initProvider) && has(self.initProvider.addressFamily))" } ], "additionalProperties": false }, "status": { "description": "VPCIpamPoolStatus defines the observed state of VPCIpamPool.", "properties": { "atProvider": { "properties": { "addressFamily": { "description": "The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.", "type": "string" }, "allocationDefaultNetmaskLength": { "description": "A default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16 (unless you provide a different netmask value when you create the new allocation).", "type": "number" }, "allocationMaxNetmaskLength": { "description": "The maximum netmask length that will be required for CIDR allocations in this pool.", "type": "number" }, "allocationMinNetmaskLength": { "description": "The minimum netmask length that will be required for CIDR allocations in this pool.", "type": "number" }, "allocationResourceTags": { "additionalProperties": { "type": "string" }, "description": "Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.", "type": "object", "x-kubernetes-map-type": "granular" }, "arn": { "description": "Amazon Resource Name (ARN) of IPAM", "type": "string" }, "autoImport": { "description": "If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall\nwithin the CIDR range in the pool.", "type": "boolean" }, "awsService": { "description": "Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.", "type": "string" }, "cascade": { "description": "Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.", "type": "boolean" }, "description": { "description": "A description for the IPAM pool.", "type": "string" }, "id": { "description": "The ID of the IPAM", "type": "string" }, "ipamScopeId": { "description": "The ID of the scope in which you would like to create the IPAM pool.", "type": "string" }, "ipamScopeType": { "type": "string" }, "locale": { "description": "The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.", "type": "string" }, "poolDepth": { "type": "number" }, "publicIpSource": { "description": "The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.", "type": "string" }, "publiclyAdvertisable": { "description": "Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = \"ipv6\" and public_ip_source = \"byoip\", default is false. This option is not available for IPv4 pool space or if public_ip_source = \"amazon\". Setting this argument to true when it is not available may result in erroneous differences being reported.", "type": "boolean" }, "region": { "description": "Region where this resource will be managed. Defaults to the Region set in the provider configuration.\nRegion is the region you'd like your resource to be created in.", "type": "string" }, "sourceIpamPoolId": { "description": "The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.", "type": "string" }, "state": { "description": "The ID of the IPAM", "type": "string" }, "tags": { "additionalProperties": { "type": "string" }, "description": "Key-value map of resource tags.", "type": "object", "x-kubernetes-map-type": "granular" }, "tagsAll": { "additionalProperties": { "type": "string" }, "description": "A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.", "type": "object", "x-kubernetes-map-type": "granular" } }, "type": "object", "additionalProperties": false }, "conditions": { "description": "Conditions of the resource.", "items": { "description": "A Condition that may apply to a resource.", "properties": { "lastTransitionTime": { "description": "LastTransitionTime is the last time this condition transitioned from one\nstatus to another.", "format": "date-time", "type": "string" }, "message": { "description": "A Message containing details about this condition's last transition from\none status to another, if any.", "type": "string" }, "observedGeneration": { "description": "ObservedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "type": "integer" }, "reason": { "description": "A Reason for this condition's last transition from one status to another.", "type": "string" }, "status": { "description": "Status of this condition; is it currently True, False, or Unknown?", "type": "string" }, "type": { "description": "Type of this condition. At most one of each condition type may apply to\na resource at any point in time.", "type": "string" } }, "required": [ "lastTransitionTime", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "observedGeneration": { "description": "ObservedGeneration is the latest metadata.generation\nwhich resulted in either a ready state, or stalled due to error\nit can not recover from without human intervention.", "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false } }, "required": [ "spec" ], "type": "object" }