Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.
After you have initiated a resource creation request, you can monitor
the progress of your request by calling
GetResourceRequestStatus
using the RequestToken
of the ProgressEvent
type returned by
CreateResource
.
Synopsis
- data CreateResource = CreateResource' {
- clientToken :: Maybe Text
- typeVersionId :: Maybe Text
- roleArn :: Maybe Text
- typeName :: Text
- desiredState :: Sensitive Text
- newCreateResource :: Text -> Text -> CreateResource
- createResource_clientToken :: Lens' CreateResource (Maybe Text)
- createResource_typeVersionId :: Lens' CreateResource (Maybe Text)
- createResource_roleArn :: Lens' CreateResource (Maybe Text)
- createResource_typeName :: Lens' CreateResource Text
- createResource_desiredState :: Lens' CreateResource Text
- data CreateResourceResponse = CreateResourceResponse' {}
- newCreateResourceResponse :: Int -> CreateResourceResponse
- createResourceResponse_progressEvent :: Lens' CreateResourceResponse (Maybe ProgressEvent)
- createResourceResponse_httpStatus :: Lens' CreateResourceResponse Int
Creating a Request
data CreateResource Source #
See: newCreateResource
smart constructor.
CreateResource' | |
|
Instances
Create a value of CreateResource
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:clientToken:CreateResource'
, createResource_clientToken
- A unique identifier to ensure the idempotency of the resource request.
As a best practice, specify this token to ensure idempotency, so that
Amazon Web Services Cloud Control API can accurately distinguish between
request retries and new resource requests. You might retry a resource
request to ensure that it was successfully received.
A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.
$sel:typeVersionId:CreateResource'
, createResource_typeVersionId
- For private resource types, the type version to use in this resource
operation. If you do not specify a resource version, CloudFormation uses
the default version.
$sel:roleArn:CreateResource'
, createResource_roleArn
- The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) for Cloud Control API to use when performing this resource
operation. The role specified must have the permissions required for
this operation. The necessary permissions for each event handler are
defined in the handlers
section of the
resource type definition schema.
If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.
For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
$sel:typeName:CreateResource'
, createResource_typeName
- The name of the resource type.
$sel:desiredState:CreateResource'
, createResource_desiredState
- Structured data format representing the desired state of the resource,
consisting of that resource's properties and their desired values.
Cloud Control API currently supports JSON as a structured data format.
Specify the desired state as one of the following:
- A JSON blob
- A local path containing the desired state in JSON data format
For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.
For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the Amazon Web Services CloudFormation Users Guide.
Request Lenses
createResource_clientToken :: Lens' CreateResource (Maybe Text) Source #
A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.
A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.
createResource_typeVersionId :: Lens' CreateResource (Maybe Text) Source #
For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.
createResource_roleArn :: Lens' CreateResource (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) for Cloud Control API to use when performing this resource
operation. The role specified must have the permissions required for
this operation. The necessary permissions for each event handler are
defined in the handlers
section of the
resource type definition schema.
If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.
For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
createResource_typeName :: Lens' CreateResource Text Source #
The name of the resource type.
createResource_desiredState :: Lens' CreateResource Text Source #
Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.
Cloud Control API currently supports JSON as a structured data format.
Specify the desired state as one of the following:
- A JSON blob
- A local path containing the desired state in JSON data format
For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.
For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the Amazon Web Services CloudFormation Users Guide.
Destructuring the Response
data CreateResourceResponse Source #
See: newCreateResourceResponse
smart constructor.
CreateResourceResponse' | |
|
Instances
newCreateResourceResponse Source #
Create a value of CreateResourceResponse
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:progressEvent:CreateResourceResponse'
, createResourceResponse_progressEvent
- Represents the current status of the resource creation request.
After you have initiated a resource creation request, you can monitor
the progress of your request by calling
GetResourceRequestStatus
using the RequestToken
of the ProgressEvent
returned by
CreateResource
.
$sel:httpStatus:CreateResourceResponse'
, createResourceResponse_httpStatus
- The response's http status code.
Response Lenses
createResourceResponse_progressEvent :: Lens' CreateResourceResponse (Maybe ProgressEvent) Source #
Represents the current status of the resource creation request.
After you have initiated a resource creation request, you can monitor
the progress of your request by calling
GetResourceRequestStatus
using the RequestToken
of the ProgressEvent
returned by
CreateResource
.
createResourceResponse_httpStatus :: Lens' CreateResourceResponse Int Source #
The response's http status code.