amazonka-codeartifact-2.0: Amazon CodeArtifact SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeArtifact.CreateDomain

Description

Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it's in multiple repositories.

Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.

Synopsis

Creating a Request

data CreateDomain Source #

See: newCreateDomain smart constructor.

Constructors

CreateDomain' 

Fields

  • encryptionKey :: Maybe Text

    The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.

    CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

  • tags :: Maybe [Tag]

    One or more tag key-value pairs for the domain.

  • domain :: Text

    The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

Instances

Instances details
ToJSON CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

ToHeaders CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

ToPath CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

ToQuery CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

AWSRequest CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

Associated Types

type AWSResponse CreateDomain #

Generic CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

Associated Types

type Rep CreateDomain :: Type -> Type #

Read CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

Show CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

NFData CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

Methods

rnf :: CreateDomain -> () #

Eq CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

Hashable CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

type AWSResponse CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

type Rep CreateDomain Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

type Rep CreateDomain = D1 ('MetaData "CreateDomain" "Amazonka.CodeArtifact.CreateDomain" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "CreateDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDomain Source #

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

CreateDomain, createDomain_encryptionKey - The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

$sel:tags:CreateDomain', createDomain_tags - One or more tag key-value pairs for the domain.

CreateDomain, createDomain_domain - The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

Request Lenses

createDomain_encryptionKey :: Lens' CreateDomain (Maybe Text) Source #

The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

createDomain_tags :: Lens' CreateDomain (Maybe [Tag]) Source #

One or more tag key-value pairs for the domain.

createDomain_domain :: Lens' CreateDomain Text Source #

The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

Destructuring the Response

data CreateDomainResponse Source #

See: newCreateDomainResponse smart constructor.

Constructors

CreateDomainResponse' 

Fields

Instances

Instances details
Generic CreateDomainResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

Associated Types

type Rep CreateDomainResponse :: Type -> Type #

Read CreateDomainResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

Show CreateDomainResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

NFData CreateDomainResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

Methods

rnf :: CreateDomainResponse -> () #

Eq CreateDomainResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

type Rep CreateDomainResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.CreateDomain

type Rep CreateDomainResponse = D1 ('MetaData "CreateDomainResponse" "Amazonka.CodeArtifact.CreateDomain" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "CreateDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDomainResponse Source #

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

CreateDomain, createDomainResponse_domain - Contains information about the created domain after processing the request.

$sel:httpStatus:CreateDomainResponse', createDomainResponse_httpStatus - The response's http status code.

Response Lenses

createDomainResponse_domain :: Lens' CreateDomainResponse (Maybe DomainDescription) Source #

Contains information about the created domain after processing the request.