Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. getIpamScope

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.getIpamScope

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Schema of AWS::EC2::IPAMScope Type

    Using getIpamScope

    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 getIpamScope(args: GetIpamScopeArgs, opts?: InvokeOptions): Promise<GetIpamScopeResult>
function getIpamScopeOutput(args: GetIpamScopeOutputArgs, opts?: InvokeOptions): Output<GetIpamScopeResult>
    def get_ipam_scope(ipam_scope_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetIpamScopeResult
def get_ipam_scope_output(ipam_scope_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetIpamScopeResult]
    func LookupIpamScope(ctx *Context, args *LookupIpamScopeArgs, opts ...InvokeOption) (*LookupIpamScopeResult, error)
func LookupIpamScopeOutput(ctx *Context, args *LookupIpamScopeOutputArgs, opts ...InvokeOption) LookupIpamScopeResultOutput

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

    public static class GetIpamScope 
{
    public static Task<GetIpamScopeResult> InvokeAsync(GetIpamScopeArgs args, InvokeOptions? opts = null)
    public static Output<GetIpamScopeResult> Invoke(GetIpamScopeInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIpamScopeResult> getIpamScope(GetIpamScopeArgs args, InvokeOptions options)
public static Output<GetIpamScopeResult> getIpamScope(GetIpamScopeArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:ec2:getIpamScope
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IpamScopeId string
    Id of the IPAM scope.
    IpamScopeId string
    Id of the IPAM scope.
    ipamScopeId String
    Id of the IPAM scope.
    ipamScopeId string
    Id of the IPAM scope.
    ipam_scope_id str
    Id of the IPAM scope.
    ipamScopeId String
    Id of the IPAM scope.

    getIpamScope Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the IPAM scope.
    Description string
    The description of the scope.
    IpamArn string
    The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
    IpamScopeId string
    Id of the IPAM scope.
    IpamScopeType Pulumi.AwsNative.Ec2.IpamScopeType
    Determines whether this scope contains publicly routable space or space for a private network
    IsDefault bool
    Is this one of the default scopes created with the IPAM.
    PoolCount int
    The number of pools that currently exist in this scope.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Arn string
    The Amazon Resource Name (ARN) of the IPAM scope.
    Description string
    The description of the scope.
    IpamArn string
    The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
    IpamScopeId string
    Id of the IPAM scope.
    IpamScopeType IpamScopeType
    Determines whether this scope contains publicly routable space or space for a private network
    IsDefault bool
    Is this one of the default scopes created with the IPAM.
    PoolCount int
    The number of pools that currently exist in this scope.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    arn String
    The Amazon Resource Name (ARN) of the IPAM scope.
    description String
    The description of the scope.
    ipamArn String
    The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
    ipamScopeId String
    Id of the IPAM scope.
    ipamScopeType IpamScopeType
    Determines whether this scope contains publicly routable space or space for a private network
    isDefault Boolean
    Is this one of the default scopes created with the IPAM.
    poolCount Integer
    The number of pools that currently exist in this scope.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    arn string
    The Amazon Resource Name (ARN) of the IPAM scope.
    description string
    The description of the scope.
    ipamArn string
    The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
    ipamScopeId string
    Id of the IPAM scope.
    ipamScopeType IpamScopeType
    Determines whether this scope contains publicly routable space or space for a private network
    isDefault boolean
    Is this one of the default scopes created with the IPAM.
    poolCount number
    The number of pools that currently exist in this scope.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    arn str
    The Amazon Resource Name (ARN) of the IPAM scope.
    description str
    The description of the scope.
    ipam_arn str
    The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
    ipam_scope_id str
    Id of the IPAM scope.
    ipam_scope_type IpamScopeType
    Determines whether this scope contains publicly routable space or space for a private network
    is_default bool
    Is this one of the default scopes created with the IPAM.
    pool_count int
    The number of pools that currently exist in this scope.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    arn String
    The Amazon Resource Name (ARN) of the IPAM scope.
    description String
    The description of the scope.
    ipamArn String
    The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
    ipamScopeId String
    Id of the IPAM scope.
    ipamScopeType "public" | "private"
    Determines whether this scope contains publicly routable space or space for a private network
    isDefault Boolean
    Is this one of the default scopes created with the IPAM.
    poolCount Number
    The number of pools that currently exist in this scope.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    IpamScopeType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native