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.DeleteResource

Description

Deletes the specified resource. For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.

Synopsis

Creating a Request

data DeleteResource Source #

See: newDeleteResource smart constructor.

Constructors

DeleteResource' 

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.

  • identifier :: Text

    The identifier for the resource.

    You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

    For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

    For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

Instances

Instances details
Eq DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Read DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Show DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Generic DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Associated Types

type Rep DeleteResource :: Type -> Type #

NFData DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Methods

rnf :: DeleteResource -> () #

Hashable DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

ToJSON DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

AWSRequest DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Associated Types

type AWSResponse DeleteResource #

ToHeaders DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

ToPath DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

ToQuery DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

type Rep DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

type Rep DeleteResource = D1 ('MetaData "DeleteResource" "Amazonka.CloudControl.DeleteResource" "libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol" 'False) (C1 ('MetaCons "DeleteResource'" '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 "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DeleteResource Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

newDeleteResource Source #

Create a value of DeleteResource 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:DeleteResource', deleteResource_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:DeleteResource', deleteResource_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:DeleteResource', deleteResource_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:DeleteResource', deleteResource_typeName - The name of the resource type.

$sel:identifier:DeleteResource', deleteResource_identifier - The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

Request Lenses

deleteResource_clientToken :: Lens' DeleteResource (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.

deleteResource_typeVersionId :: Lens' DeleteResource (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.

deleteResource_roleArn :: Lens' DeleteResource (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.

deleteResource_typeName :: Lens' DeleteResource Text Source #

The name of the resource type.

deleteResource_identifier :: Lens' DeleteResource Text Source #

The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

Destructuring the Response

data DeleteResourceResponse Source #

See: newDeleteResourceResponse smart constructor.

Constructors

DeleteResourceResponse' 

Fields

  • progressEvent :: Maybe ProgressEvent

    Represents the current status of the resource deletion request.

    After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DeleteResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Show DeleteResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Generic DeleteResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Associated Types

type Rep DeleteResourceResponse :: Type -> Type #

NFData DeleteResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

Methods

rnf :: DeleteResourceResponse -> () #

type Rep DeleteResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.DeleteResource

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

newDeleteResourceResponse Source #

Create a value of DeleteResourceResponse 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:DeleteResourceResponse', deleteResourceResponse_progressEvent - Represents the current status of the resource deletion request.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.

$sel:httpStatus:DeleteResourceResponse', deleteResourceResponse_httpStatus - The response's http status code.

Response Lenses

deleteResourceResponse_progressEvent :: Lens' DeleteResourceResponse (Maybe ProgressEvent) Source #

Represents the current status of the resource deletion request.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.