libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudControl.CreateResource

Description

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

Creating a Request

data CreateResource Source #

See: newCreateResource smart constructor.

Constructors

CreateResource' 

Fields

  • clientToken :: Maybe Text

    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.

  • typeVersionId :: Maybe Text

    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.

  • roleArn :: Maybe Text

    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.

  • typeName :: Text

    The name of the resource type.

  • desiredState :: Sensitive Text

    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.

Instances

Instances details
Eq CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

Show CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

Generic CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

Associated Types

type Rep CreateResource :: Type -> Type #

NFData CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

Methods

rnf :: CreateResource -> () #

Hashable CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

ToJSON CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

AWSRequest CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

Associated Types

type AWSResponse CreateResource #

ToHeaders CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

ToPath CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

ToQuery CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

type Rep CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

type Rep CreateResource = D1 ('MetaData "CreateResource" "Amazonka.CloudControl.CreateResource" "libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol" 'False) (C1 ('MetaCons "CreateResource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "typeVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "desiredState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))
type AWSResponse CreateResource Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

newCreateResource Source #

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.

Constructors

CreateResourceResponse' 

Fields

  • progressEvent :: Maybe 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

Show CreateResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

Generic CreateResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

Associated Types

type Rep CreateResourceResponse :: Type -> Type #

NFData CreateResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

Methods

rnf :: CreateResourceResponse -> () #

type Rep CreateResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.CreateResource

type Rep CreateResourceResponse = D1 ('MetaData "CreateResourceResponse" "Amazonka.CloudControl.CreateResource" "libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol" 'False) (C1 ('MetaCons "CreateResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "progressEvent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProgressEvent)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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.