AWSEC2CreateIpamPoolRequest

Objective-C

@interface AWSEC2CreateIpamPoolRequest

Swift

class AWSEC2CreateIpamPoolRequest
  • The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2AddressFamily addressFamily;

    Swift

    var addressFamily: AWSEC2AddressFamily { get set }
  • The 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable allocationDefaultNetmaskLength;

    Swift

    var allocationDefaultNetmaskLength: NSNumber? { get set }
  • The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable allocationMaxNetmaskLength;

    Swift

    var allocationMaxNetmaskLength: NSNumber? { get set }
  • The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable allocationMinNetmaskLength;

    Swift

    var allocationMinNetmaskLength: NSNumber? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2RequestIpamResourceTag *> *_Nullable allocationResourceTags;

    Swift

    var allocationResourceTags: [AWSEC2RequestIpamResourceTag]? { get set }
  • If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool’s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

    A locale must be set on the pool for this feature to work.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable autoImport;

    Swift

    var autoImport: NSNumber? { get set }
  • Limits which service in Amazon Web Services that the pool can be used in. “ec2”, for example, allows users to use space for Elastic IP addresses and VPCs.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2IpamPoolAwsService awsService;

    Swift

    var awsService: AWSEC2IpamPoolAwsService { get set }
  • A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientToken;

    Swift

    var clientToken: String? { get set }
  • A description for the IPAM pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }
  • A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable dryRun;

    Swift

    var dryRun: NSNumber? { get set }
  • The ID of the scope in which you would like to create the IPAM pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable ipamScopeId;

    Swift

    var ipamScopeId: String? { get set }
  • In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM’s home region cannot use CIDRs from this pool.

    Possible values: Any Amazon Web Services Region, such as us-east-1.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable locale;

    Swift

    var locale: String? { get set }
  • The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2IpamPoolPublicIpSource publicIpSource;

    Swift

    var publicIpSource: AWSEC2IpamPoolPublicIpSource { get set }
  • Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable publiclyAdvertisable;

    Swift

    var publiclyAdvertisable: NSNumber? { get set }
  • The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool’s CIDR range.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sourceIpamPoolId;

    Swift

    var sourceIpamPoolId: String? { get set }
  • The resource used to provision CIDRs to a resource planning pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2IpamPoolSourceResourceRequest *_Nullable sourceResource;

    Swift

    var sourceResource: AWSEC2IpamPoolSourceResourceRequest? { get set }
  • The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2TagSpecification *> *_Nullable tagSpecifications;

    Swift

    var tagSpecifications: [AWSEC2TagSpecification]? { get set }