AWS Native
getIPAM
Resource Schema of AWS::EC2::IPAM Type
Using getIPAM
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 getIPAM(args: GetIPAMArgs, opts?: InvokeOptions): Promise<GetIPAMResult>
function getIPAMOutput(args: GetIPAMOutputArgs, opts?: InvokeOptions): Output<GetIPAMResult>
def get_ipam(ipam_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIPAMResult
def get_ipam_output(ipam_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIPAMResult]
func LookupIPAM(ctx *Context, args *LookupIPAMArgs, opts ...InvokeOption) (*LookupIPAMResult, error)
func LookupIPAMOutput(ctx *Context, args *LookupIPAMOutputArgs, opts ...InvokeOption) LookupIPAMResultOutput
> Note: This function is named LookupIPAM
in the Go SDK.
public static class GetIPAM
{
public static Task<GetIPAMResult> InvokeAsync(GetIPAMArgs args, InvokeOptions? opts = null)
public static Output<GetIPAMResult> Invoke(GetIPAMInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIPAMResult> getIPAM(GetIPAMArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: aws-native:ec2:getIPAM
Arguments:
# Arguments dictionary
The following arguments are supported:
- Ipam
Id string Id of the IPAM.
- Ipam
Id string Id of the IPAM.
- ipam
Id String Id of the IPAM.
- ipam
Id string Id of the IPAM.
- ipam_
id str Id of the IPAM.
- ipam
Id String Id of the IPAM.
getIPAM Result
The following output properties are available:
- Arn string
The Amazon Resource Name (ARN) of the IPAM.
- Description string
- Ipam
Id string Id of the IPAM.
- Operating
Regions List<Pulumi.Aws Native. EC2. Outputs. IPAMIpam Operating Region> The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- Private
Default stringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- Public
Default stringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- Scope
Count int The number of scopes that currently exist in this IPAM.
- List<Pulumi.
Aws Native. EC2. Outputs. IPAMTag> An array of key-value pairs to apply to this resource.
- Arn string
The Amazon Resource Name (ARN) of the IPAM.
- Description string
- Ipam
Id string Id of the IPAM.
- Operating
Regions []IPAMIpamOperating Region The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- Private
Default stringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- Public
Default stringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- Scope
Count int The number of scopes that currently exist in this IPAM.
- []IPAMTag
An array of key-value pairs to apply to this resource.
- arn String
The Amazon Resource Name (ARN) of the IPAM.
- description String
- ipam
Id String Id of the IPAM.
- operating
Regions ListOperating Region> The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- private
Default StringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- public
Default StringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- scope
Count Integer The number of scopes that currently exist in this IPAM.
- List
An array of key-value pairs to apply to this resource.
- arn string
The Amazon Resource Name (ARN) of the IPAM.
- description string
- ipam
Id string Id of the IPAM.
- operating
Regions IPAMIpamOperating Region[] The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- private
Default stringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- public
Default stringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- scope
Count number The number of scopes that currently exist in this IPAM.
- IPAMTag[]
An array of key-value pairs to apply to this resource.
- arn str
The Amazon Resource Name (ARN) of the IPAM.
- description str
- ipam_
id str Id of the IPAM.
- operating_
regions Sequence[IPAMIpamOperating Region] The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- private_
default_ strscope_ id The Id of the default scope for publicly routable IP space, created with this IPAM.
- public_
default_ strscope_ id The Id of the default scope for publicly routable IP space, created with this IPAM.
- scope_
count int The number of scopes that currently exist in this IPAM.
- Sequence[IPAMTag]
An array of key-value pairs to apply to this resource.
- arn String
The Amazon Resource Name (ARN) of the IPAM.
- description String
- ipam
Id String Id of the IPAM.
- operating
Regions List The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
- private
Default StringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- public
Default StringScope Id The Id of the default scope for publicly routable IP space, created with this IPAM.
- scope
Count Number The number of scopes that currently exist in this IPAM.
- List
An array of key-value pairs to apply to this resource.
Supporting Types
IPAMIpamOperatingRegion
- Region
Name string The name of the region.
- Region
Name string The name of the region.
- region
Name String The name of the region.
- region
Name string The name of the region.
- region_
name str The name of the region.
- region
Name String The name of the region.
IPAMTag
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws-native
- License
- Apache-2.0