| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.EC2.CreateIpamScope
Description
Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
Synopsis
- data CreateIpamScope = CreateIpamScope' {
- clientToken :: Maybe Text
- description :: Maybe Text
- dryRun :: Maybe Bool
- tagSpecifications :: Maybe [TagSpecification]
- ipamId :: Text
- newCreateIpamScope :: Text -> CreateIpamScope
- createIpamScope_clientToken :: Lens' CreateIpamScope (Maybe Text)
- createIpamScope_description :: Lens' CreateIpamScope (Maybe Text)
- createIpamScope_dryRun :: Lens' CreateIpamScope (Maybe Bool)
- createIpamScope_tagSpecifications :: Lens' CreateIpamScope (Maybe [TagSpecification])
- createIpamScope_ipamId :: Lens' CreateIpamScope Text
- data CreateIpamScopeResponse = CreateIpamScopeResponse' {
- ipamScope :: Maybe IpamScope
- httpStatus :: Int
- newCreateIpamScopeResponse :: Int -> CreateIpamScopeResponse
- createIpamScopeResponse_ipamScope :: Lens' CreateIpamScopeResponse (Maybe IpamScope)
- createIpamScopeResponse_httpStatus :: Lens' CreateIpamScopeResponse Int
Creating a Request
data CreateIpamScope Source #
See: newCreateIpamScope smart constructor.
Constructors
| CreateIpamScope' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CreateIpamScope |
Create a value of CreateIpamScope with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateIpamScope, createIpamScope_clientToken - A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see
Ensuring Idempotency.
CreateIpamScope, createIpamScope_description - A description for the scope you're creating.
$sel:dryRun:CreateIpamScope', createIpamScope_dryRun - 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.
CreateIpamScope, createIpamScope_tagSpecifications - 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.
CreateIpamScope, createIpamScope_ipamId - The ID of the IPAM for which you're creating this scope.
Request Lenses
createIpamScope_clientToken :: Lens' CreateIpamScope (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
createIpamScope_description :: Lens' CreateIpamScope (Maybe Text) Source #
A description for the scope you're creating.
createIpamScope_dryRun :: Lens' CreateIpamScope (Maybe Bool) Source #
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.
createIpamScope_tagSpecifications :: Lens' CreateIpamScope (Maybe [TagSpecification]) Source #
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.
createIpamScope_ipamId :: Lens' CreateIpamScope Text Source #
The ID of the IPAM for which you're creating this scope.
Destructuring the Response
data CreateIpamScopeResponse Source #
See: newCreateIpamScopeResponse smart constructor.
Constructors
| CreateIpamScopeResponse' | |
Fields
| |
Instances
newCreateIpamScopeResponse Source #
Create a value of CreateIpamScopeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipamScope:CreateIpamScopeResponse', createIpamScopeResponse_ipamScope - Information about the created scope.
$sel:httpStatus:CreateIpamScopeResponse', createIpamScopeResponse_httpStatus - The response's http status code.
Response Lenses
createIpamScopeResponse_ipamScope :: Lens' CreateIpamScopeResponse (Maybe IpamScope) Source #
Information about the created scope.
createIpamScopeResponse_httpStatus :: Lens' CreateIpamScopeResponse Int Source #
The response's http status code.