Amazonka.Proton.UpdateComponent

Update a component.

There are a few modes for updating a component. The deploymentType field defines the mode.

You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS.

For more information about components, see Proton components in the Proton User Guide.

Creating a Request

data UpdateComponent

See: newUpdateComponent smart constructor.

Constructors

UpdateComponent'

Fields

• description :: Maybe (Sensitive Text)

  An optional customer-provided description of the component.

• serviceInstanceName :: Maybe Text

  The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

• serviceName :: Maybe Text

  The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

• serviceSpec :: Maybe (Sensitive Text)

  The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

• templateFile :: Maybe (Sensitive Text)

  A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

  Components support a single IaC file, even if you use Terraform as your template language.

• deploymentType :: ComponentDeploymentUpdateType

  The deployment type. It defines the mode for updating a component, as follows:

  [] NONE

  In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

  [] CURRENT_VERSION

  In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

• name :: Text

  The name of the component to update.

Instances

ToJSON UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Methods

toJSON :: UpdateComponent -> Value

toEncoding :: UpdateComponent -> Encoding

toJSONList :: [UpdateComponent] -> Value

toEncodingList :: [UpdateComponent] -> Encoding

ToHeaders UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Methods

toHeaders :: UpdateComponent -> [Header]

ToPath UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Methods

toPath :: UpdateComponent -> ByteString

ToQuery UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Methods

toQuery :: UpdateComponent -> QueryString

AWSRequest UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Associated Types

type AWSResponse UpdateComponent

Methods

request :: (Service -> Service) -> UpdateComponent -> Request UpdateComponent

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateComponent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateComponent)))

Generic UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Associated Types

type Rep UpdateComponent :: Type -> Type

Methods

from :: UpdateComponent -> Rep UpdateComponent x

to :: Rep UpdateComponent x -> UpdateComponent

Show UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Methods

showsPrec :: Int -> UpdateComponent -> ShowS

show :: UpdateComponent -> String

showList :: [UpdateComponent] -> ShowS

NFData UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Methods

rnf :: UpdateComponent -> ()

Eq UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Methods

(==) :: UpdateComponent -> UpdateComponent -> Bool

(/=) :: UpdateComponent -> UpdateComponent -> Bool

Hashable UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

Methods

hashWithSalt :: Int -> UpdateComponent -> Int

hash :: UpdateComponent -> Int

type AWSResponse UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

type AWSResponse UpdateComponent = UpdateComponentResponse

type Rep UpdateComponent

Defined in Amazonka.Proton.UpdateComponent

type Rep UpdateComponent = D1 ('MetaData "UpdateComponent" "Amazonka.Proton.UpdateComponent" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "UpdateComponent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "serviceInstanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "serviceSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "templateFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "deploymentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ComponentDeploymentUpdateType) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateComponent

Arguments

:: ComponentDeploymentUpdateType

$sel:deploymentType:UpdateComponent'

-> Text

UpdateComponent

-> UpdateComponent

Create a value of UpdateComponent 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:

UpdateComponent, updateComponent_description - An optional customer-provided description of the component.

UpdateComponent, updateComponent_serviceInstanceName - The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

UpdateComponent, updateComponent_serviceName - The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

UpdateComponent, updateComponent_serviceSpec - The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

$sel:templateFile:UpdateComponent', updateComponent_templateFile - A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

$sel:deploymentType:UpdateComponent', updateComponent_deploymentType - The deployment type. It defines the mode for updating a component, as follows:

[] NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

[] CURRENT_VERSION

In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

UpdateComponent, updateComponent_name - The name of the component to update.

Request Lenses

updateComponent_description :: Lens' UpdateComponent (Maybe Text)

An optional customer-provided description of the component.

updateComponent_serviceInstanceName :: Lens' UpdateComponent (Maybe Text)

The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

updateComponent_serviceName :: Lens' UpdateComponent (Maybe Text)

The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

updateComponent_serviceSpec :: Lens' UpdateComponent (Maybe Text)

The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

updateComponent_templateFile :: Lens' UpdateComponent (Maybe Text)

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

updateComponent_deploymentType :: Lens' UpdateComponent ComponentDeploymentUpdateType

The deployment type. It defines the mode for updating a component, as follows:

[] NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

[] CURRENT_VERSION

In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

updateComponent_name :: Lens' UpdateComponent Text

The name of the component to update.

Destructuring the Response

data UpdateComponentResponse

See: newUpdateComponentResponse smart constructor.

Constructors

UpdateComponentResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• component :: Component

  The detailed data of the updated component.

Instances

Generic UpdateComponentResponse

Defined in Amazonka.Proton.UpdateComponent

Associated Types

type Rep UpdateComponentResponse :: Type -> Type

Methods

from :: UpdateComponentResponse -> Rep UpdateComponentResponse x

to :: Rep UpdateComponentResponse x -> UpdateComponentResponse

Show UpdateComponentResponse

Defined in Amazonka.Proton.UpdateComponent

Methods

showsPrec :: Int -> UpdateComponentResponse -> ShowS

show :: UpdateComponentResponse -> String

showList :: [UpdateComponentResponse] -> ShowS

NFData UpdateComponentResponse

Defined in Amazonka.Proton.UpdateComponent

Methods

rnf :: UpdateComponentResponse -> ()

Eq UpdateComponentResponse

Defined in Amazonka.Proton.UpdateComponent

Methods

(==) :: UpdateComponentResponse -> UpdateComponentResponse -> Bool

(/=) :: UpdateComponentResponse -> UpdateComponentResponse -> Bool

type Rep UpdateComponentResponse

Defined in Amazonka.Proton.UpdateComponent

type Rep UpdateComponentResponse = D1 ('MetaData "UpdateComponentResponse" "Amazonka.Proton.UpdateComponent" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "UpdateComponentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "component") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Component)))

newUpdateComponentResponse

Arguments

:: Int

$sel:httpStatus:UpdateComponentResponse'

-> Component

$sel:component:UpdateComponentResponse'

-> UpdateComponentResponse

Create a value of UpdateComponentResponse 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:httpStatus:UpdateComponentResponse', updateComponentResponse_httpStatus - The response's http status code.

$sel:component:UpdateComponentResponse', updateComponentResponse_component - The detailed data of the updated component.

Response Lenses

updateComponentResponse_httpStatus :: Lens' UpdateComponentResponse Int

The response's http status code.

updateComponentResponse_component :: Lens' UpdateComponentResponse Component

The detailed data of the updated component.