Package software.amazon.awssdk.services.cloudcontrol.model

Interface DeleteResourceRequest.Builder

    • Method Detail

      • typeName

        DeleteResourceRequest.Builder typeName​(String typeName)

        The name of the resource type.

        Parameters:
        typeName - The name of the resource type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • typeVersionId

        DeleteResourceRequest.Builder typeVersionId​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        DeleteResourceRequest.Builder roleArn​(String roleArn)

        The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role 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.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        DeleteResourceRequest.Builder clientToken​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • identifier

        DeleteResourceRequest.Builder identifier​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.