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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.IpamScope

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Schema of AWS::EC2::IPAMScope Type

Create IpamScope Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IpamScope(name: string, args: IpamScopeArgs, opts?: CustomResourceOptions);
@overload
def IpamScope(resource_name: str,
              args: IpamScopeArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def IpamScope(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              ipam_id: Optional[str] = None,
              description: Optional[str] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewIpamScope(ctx *Context, name string, args IpamScopeArgs, opts ...ResourceOption) (*IpamScope, error)
public IpamScope(string name, IpamScopeArgs args, CustomResourceOptions? opts = null)
public IpamScope(String name, IpamScopeArgs args)
public IpamScope(String name, IpamScopeArgs args, CustomResourceOptions options)

type: aws-native:ec2:IpamScope
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IpamScopeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IpamScopeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IpamScopeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IpamScopeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IpamScopeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

IpamScope Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IpamScope resource accepts the following input properties:

IpamId This property is required. string
The Id of the IPAM this scope is a part of.
Description string
The description of the scope.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
IpamId This property is required. string
The Id of the IPAM this scope is a part of.
Description string
The description of the scope.
Tags TagArgs
An array of key-value pairs to apply to this resource.
ipamId This property is required. String
The Id of the IPAM this scope is a part of.
description String
The description of the scope.
tags List<Tag>
An array of key-value pairs to apply to this resource.
ipamId This property is required. string
The Id of the IPAM this scope is a part of.
description string
The description of the scope.
tags Tag[]
An array of key-value pairs to apply to this resource.
ipam_id This property is required. str
The Id of the IPAM this scope is a part of.
description str
The description of the scope.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
ipamId This property is required. String
The Id of the IPAM this scope is a part of.
description String
The description of the scope.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the IpamScope resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) of the IPAM scope.
Id string
The provider-assigned unique ID for this managed resource.
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.
Arn string
The Amazon Resource Name (ARN) of the IPAM scope.
Id string
The provider-assigned unique ID for this managed resource.
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.
arn String
The Amazon Resource Name (ARN) of the IPAM scope.
id String
The provider-assigned unique ID for this managed resource.
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.
arn string
The Amazon Resource Name (ARN) of the IPAM scope.
id string
The provider-assigned unique ID for this managed resource.
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.
arn str
The Amazon Resource Name (ARN) of the IPAM scope.
id str
The provider-assigned unique ID for this managed resource.
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.
arn String
The Amazon Resource Name (ARN) of the IPAM scope.
id String
The provider-assigned unique ID for this managed resource.
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.

Supporting Types

IpamScopeType
, IpamScopeTypeArgs

Public
public
Private
private
IpamScopeTypePublic
public
IpamScopeTypePrivate
private
Public
public
Private
private
Public
public
Private
private
PUBLIC
public
PRIVATE
private
"public"
public
"private"
private

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native