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

Description

Returns information about the current state of the specified resource. For details, see Reading a resource's current state.

You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether or not those resources were provisioned using Cloud Control API.

Synopsis

Creating a Request

data GetResource Source #

See: newGetResource smart constructor.

Constructors

GetResource' 

Fields

  • 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 GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

(==) :: GetResource -> GetResource -> Bool #

(/=) :: GetResource -> GetResource -> Bool #

Read GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

readsPrec :: Int -> ReadS GetResource #

readList :: ReadS [GetResource] #

readPrec :: ReadPrec GetResource #

readListPrec :: ReadPrec [GetResource] #

Show GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

showsPrec :: Int -> GetResource -> ShowS #

show :: GetResource -> String #

showList :: [GetResource] -> ShowS #

Generic GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Associated Types

type Rep GetResource :: Type -> Type #

Methods

from :: GetResource -> Rep GetResource x #

to :: Rep GetResource x -> GetResource #

NFData GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

rnf :: GetResource -> () #

Hashable GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

hashWithSalt :: Int -> GetResource -> Int #

hash :: GetResource -> Int #

ToJSON GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

toJSON :: GetResource -> Value #

toEncoding :: GetResource -> Encoding #

toJSONList :: [GetResource] -> Value #

toEncodingList :: [GetResource] -> Encoding #

AWSRequest GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Associated Types

type AWSResponse GetResource #

Methods

request :: GetResource -> Request GetResource #

response :: MonadResource m => Logger -> Service -> Proxy GetResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetResource))) #

ToHeaders GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

toHeaders :: GetResource -> [Header] #

ToPath GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

toPath :: GetResource -> ByteString #

ToQuery GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

toQuery :: GetResource -> QueryString #

type Rep GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

type Rep GetResource = D1 ('MetaData "GetResource" "Amazonka.CloudControl.GetResource" "libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol" 'False) (C1 ('MetaCons "GetResource'" 'PrefixI 'True) ((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 GetResource Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

type AWSResponse GetResource = GetResourceResponse

newGetResource Source #

Arguments

:: Text

$sel:typeName:GetResource'

-> Text

$sel:identifier:GetResource'

-> GetResource 

Create a value of GetResource 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:typeVersionId:GetResource', getResource_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:GetResource', getResource_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:GetResource', getResource_typeName - The name of the resource type.

$sel:identifier:GetResource', getResource_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

getResource_typeVersionId :: Lens' GetResource (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.

getResource_roleArn :: Lens' GetResource (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.

getResource_typeName :: Lens' GetResource Text Source #

The name of the resource type.

getResource_identifier :: Lens' GetResource 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 GetResourceResponse Source #

See: newGetResourceResponse smart constructor.

Constructors

GetResourceResponse' 

Fields

Instances

Instances details
Eq GetResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

(==) :: GetResourceResponse -> GetResourceResponse -> Bool #

(/=) :: GetResourceResponse -> GetResourceResponse -> Bool #

Show GetResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

showsPrec :: Int -> GetResourceResponse -> ShowS #

show :: GetResourceResponse -> String #

showList :: [GetResourceResponse] -> ShowS #

Generic GetResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Associated Types

type Rep GetResourceResponse :: Type -> Type #

Methods

from :: GetResourceResponse -> Rep GetResourceResponse x #

to :: Rep GetResourceResponse x -> GetResourceResponse #

NFData GetResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

Methods

rnf :: GetResourceResponse -> () #

type Rep GetResourceResponse Source # 
Instance details

Defined in Amazonka.CloudControl.GetResource

type Rep GetResourceResponse = D1 ('MetaData "GetResourceResponse" "Amazonka.CloudControl.GetResource" "libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol" 'False) (C1 ('MetaCons "GetResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetResourceResponse Source #

Arguments

:: Int

$sel:httpStatus:GetResourceResponse'

-> GetResourceResponse 

Create a value of GetResourceResponse 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:typeName:GetResource', getResourceResponse_typeName - The name of the resource type.

$sel:resourceDescription:GetResourceResponse', getResourceResponse_resourceDescription - Undocumented member.

$sel:httpStatus:GetResourceResponse', getResourceResponse_httpStatus - The response's http status code.

Response Lenses

getResourceResponse_typeName :: Lens' GetResourceResponse (Maybe Text) Source #

The name of the resource type.

getResourceResponse_resourceDescription :: Lens' GetResourceResponse (Maybe ResourceDescription) Source #

Undocumented member.

getResourceResponse_httpStatus :: Lens' GetResourceResponse Int Source #

The response's http status code.