Class: Aws::CodeArtifact::Types::CreateDomainRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codeartifact/types.rb

Overview

Note:

When making an API call, you may pass CreateDomainRequest data as a hash:

{
  domain: "DomainName", # required
  encryption_key: "Arn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain ⇒ String

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.

Returns:

  • (String) 


341
342
343
344
345
346
347
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 341

class CreateDomainRequest < Struct.new(
  :domain,
  :encryption_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_key ⇒ String

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

[1]: docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax [2]: docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html [3]: docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html

Returns:

  • (String) 


341
342
343
344
345
346
347
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 341

class CreateDomainRequest < Struct.new(
  :domain,
  :encryption_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:



341
342
343
344
345
346
347
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 341

class CreateDomainRequest < Struct.new(
  :domain,
  :encryption_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end