| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
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 AWS 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
- data CreateDomain = CreateDomain' {}
- newCreateDomain :: Text -> CreateDomain
- createDomain_encryptionKey :: Lens' CreateDomain (Maybe Text)
- createDomain_tags :: Lens' CreateDomain (Maybe [Tag])
- createDomain_domain :: Lens' CreateDomain Text
- data CreateDomainResponse = CreateDomainResponse' {}
- newCreateDomainResponse :: Int -> CreateDomainResponse
- createDomainResponse_domain :: Lens' CreateDomainResponse (Maybe DomainDescription)
- createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int
Creating a Request
data CreateDomain Source #
See: newCreateDomain smart constructor.
Constructors
| CreateDomain' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CreateDomain |
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:
$sel:encryptionKey: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 AWS Key Management Service API Reference and
AWS KMS API Permissions Reference
in the AWS 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 AWS Key Management Service Developer Guide.
$sel:tags:CreateDomain', createDomain_tags - One or more tag key-value pairs for the domain.
$sel:domain:CreateDomain', createDomain_domain - The name of the domain to create. All domain names in an AWS Region that
are in the same AWS 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 AWS Key Management Service API Reference and
AWS KMS API Permissions Reference
in the AWS 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 AWS 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 AWS Region that are in the same AWS 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
newCreateDomainResponse Source #
Arguments
| :: Int | |
| -> CreateDomainResponse |
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:
$sel:domain: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.
createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #
The response's http status code.