Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Proton.CreateComponent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Create an Proton component. A component is an infrastructure extension for a service instance.

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

Synopsis

data CreateComponent = CreateComponent' {
- description :: Maybe (Sensitive Text)
- environmentName :: Maybe Text
- serviceInstanceName :: Maybe Text
- serviceName :: Maybe Text
- serviceSpec :: Maybe (Sensitive Text)
- tags :: Maybe [Tag]
- manifest :: Sensitive Text
- name :: Text
- templateFile :: Sensitive Text
}
newCreateComponent :: Text -> Text -> Text -> CreateComponent
createComponent_description :: Lens' CreateComponent (Maybe Text)
createComponent_environmentName :: Lens' CreateComponent (Maybe Text)
createComponent_serviceInstanceName :: Lens' CreateComponent (Maybe Text)
createComponent_serviceName :: Lens' CreateComponent (Maybe Text)
createComponent_serviceSpec :: Lens' CreateComponent (Maybe Text)
createComponent_tags :: Lens' CreateComponent (Maybe [Tag])
createComponent_manifest :: Lens' CreateComponent Text
createComponent_name :: Lens' CreateComponent Text
createComponent_templateFile :: Lens' CreateComponent Text
data CreateComponentResponse = CreateComponentResponse' {
- httpStatus :: Int
- component :: Component
}
newCreateComponentResponse :: Int -> Component -> CreateComponentResponse
createComponentResponse_httpStatus :: Lens' CreateComponentResponse Int
createComponentResponse_component :: Lens' CreateComponentResponse Component

Creating a Request

data CreateComponent Source #

See: newCreateComponent smart constructor.

Constructors

CreateComponent'

Fields

description :: Maybe (Sensitive Text)
An optional customer-provided description of the component.
environmentName :: Maybe Text
The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.
serviceInstanceName :: Maybe Text
The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
serviceName :: Maybe Text
The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or 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 you attach the component to a service instance.
tags :: Maybe [Tag]
An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
manifest :: Sensitive Text
A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
name :: Text
The customer-provided name of the component.
templateFile :: 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.

Instances

Instances details

ToJSON CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods toJSON :: CreateComponent -> Value # toEncoding :: CreateComponent -> Encoding # toJSONList :: [CreateComponent] -> Value # toEncodingList :: [CreateComponent] -> Encoding #
ToHeaders CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods toHeaders :: CreateComponent -> [Header] #
ToPath CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods toPath :: CreateComponent -> ByteString #
ToQuery CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods toQuery :: CreateComponent -> QueryString #
AWSRequest CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Associated Types type AWSResponse CreateComponent # Methods request :: (Service -> Service) -> CreateComponent -> Request CreateComponent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateComponent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateComponent))) #
Generic CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Associated Types type Rep CreateComponent :: Type -> Type # Methods from :: CreateComponent -> Rep CreateComponent x # to :: Rep CreateComponent x -> CreateComponent #
Show CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods showsPrec :: Int -> CreateComponent -> ShowS # show :: CreateComponent -> String # showList :: [CreateComponent] -> ShowS #
NFData CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods rnf :: CreateComponent -> () #
Eq CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods (==) :: CreateComponent -> CreateComponent -> Bool # (/=) :: CreateComponent -> CreateComponent -> Bool #
Hashable CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods hashWithSalt :: Int -> CreateComponent -> Int # hash :: CreateComponent -> Int #
type AWSResponse CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent type AWSResponse CreateComponent = CreateComponentResponse
type Rep CreateComponent Source #
Instance details Defined in Amazonka.Proton.CreateComponent type Rep CreateComponent = D1 ('MetaData "CreateComponent" "Amazonka.Proton.CreateComponent" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "CreateComponent'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "manifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "templateFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))))

newCreateComponent Source #

Arguments

:: Text	`$sel:manifest:CreateComponent'`
-> Text	`CreateComponent`
-> Text	`$sel:templateFile:CreateComponent'`
-> CreateComponent

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

CreateComponent, createComponent_description - An optional customer-provided description of the component.

CreateComponent, createComponent_environmentName - The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.

CreateComponent, createComponent_serviceInstanceName - The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

CreateComponent, createComponent_serviceName - The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

CreateComponent, createComponent_serviceSpec - The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.

$sel:tags:CreateComponent', createComponent_tags - An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

$sel:manifest:CreateComponent', createComponent_manifest - A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.

CreateComponent, createComponent_name - The customer-provided name of the component.

$sel:templateFile:CreateComponent', createComponent_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.

Request Lenses

createComponent_description :: Lens' CreateComponent (Maybe Text) Source #

An optional customer-provided description of the component.

createComponent_environmentName :: Lens' CreateComponent (Maybe Text) Source #

The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.

createComponent_serviceInstanceName :: Lens' CreateComponent (Maybe Text) Source #

The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

createComponent_serviceName :: Lens' CreateComponent (Maybe Text) Source #

The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

createComponent_serviceSpec :: Lens' CreateComponent (Maybe Text) Source #

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

createComponent_tags :: Lens' CreateComponent (Maybe [Tag]) Source #

An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

createComponent_manifest :: Lens' CreateComponent Text Source #

A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.

createComponent_name :: Lens' CreateComponent Text Source #

The customer-provided name of the component.

createComponent_templateFile :: Lens' CreateComponent Text Source #

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.

Destructuring the Response

data CreateComponentResponse Source #

See: newCreateComponentResponse smart constructor.

Constructors

CreateComponentResponse'
Fields httpStatus :: Int The response's http status code. component :: Component The detailed data of the created component.

Instances

Instances details

Generic CreateComponentResponse Source #
Instance details Defined in Amazonka.Proton.CreateComponent Associated Types type Rep CreateComponentResponse :: Type -> Type # Methods from :: CreateComponentResponse -> Rep CreateComponentResponse x # to :: Rep CreateComponentResponse x -> CreateComponentResponse #
Show CreateComponentResponse Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods showsPrec :: Int -> CreateComponentResponse -> ShowS # show :: CreateComponentResponse -> String # showList :: [CreateComponentResponse] -> ShowS #
NFData CreateComponentResponse Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods rnf :: CreateComponentResponse -> () #
Eq CreateComponentResponse Source #
Instance details Defined in Amazonka.Proton.CreateComponent Methods (==) :: CreateComponentResponse -> CreateComponentResponse -> Bool # (/=) :: CreateComponentResponse -> CreateComponentResponse -> Bool #
type Rep CreateComponentResponse Source #
Instance details Defined in Amazonka.Proton.CreateComponent type Rep CreateComponentResponse = D1 ('MetaData "CreateComponentResponse" "Amazonka.Proton.CreateComponent" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "CreateComponentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "component") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Component)))

newCreateComponentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateComponentResponse'`
-> Component	`$sel:component:CreateComponentResponse'`
-> CreateComponentResponse

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

$sel:component:CreateComponentResponse', createComponentResponse_component - The detailed data of the created component.

Response Lenses

createComponentResponse_httpStatus :: Lens' CreateComponentResponse Int Source #

The response's http status code.

createComponentResponse_component :: Lens' CreateComponentResponse Component Source #

The detailed data of the created component.