NAME

Paws::ApiGateway::CreateDomainName - Arguments for method CreateDomainName on Paws::ApiGateway

DESCRIPTION

This class represents the parameters used for calling the method CreateDomainName on the Amazon API Gateway service. Use the attributes of this class as arguments to method CreateDomainName.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDomainName.

SYNOPSIS

    my $apigateway = Paws->service('ApiGateway');
    my $DomainName = $apigateway->CreateDomainName(
      DomainName            => 'MyString',
      CertificateArn        => 'MyString',    # OPTIONAL
      CertificateBody       => 'MyString',    # OPTIONAL
      CertificateChain      => 'MyString',    # OPTIONAL
      CertificateName       => 'MyString',    # OPTIONAL
      CertificatePrivateKey => 'MyString',    # OPTIONAL
      EndpointConfiguration => {
        types => [
          'REGIONAL', ...                     # values: REGIONAL, EDGE
        ],                                    # OPTIONAL
      },    # OPTIONAL
      RegionalCertificateArn  => 'MyString',    # OPTIONAL
      RegionalCertificateName => 'MyString',    # OPTIONAL
    );

    # Results:
    my $RegionalDomainName       = $DomainName->RegionalDomainName;
    my $DistributionHostedZoneId = $DomainName->DistributionHostedZoneId;
    my $DomainName               = $DomainName->DomainName;
    my $CertificateUploadDate    = $DomainName->CertificateUploadDate;
    my $DistributionDomainName   = $DomainName->DistributionDomainName;
    my $CertificateName          = $DomainName->CertificateName;
    my $CertificateArn           = $DomainName->CertificateArn;
    my $RegionalCertificateArn   = $DomainName->RegionalCertificateArn;
    my $RegionalHostedZoneId     = $DomainName->RegionalHostedZoneId;
    my $RegionalCertificateName  = $DomainName->RegionalCertificateName;
    my $EndpointConfiguration    = $DomainName->EndpointConfiguration;

    # Returns a L<Paws::ApiGateway::DomainName> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://aws.amazon.com/documentation/apigateway/

ATTRIBUTES

CertificateArn => Str

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

CertificateBody => Str

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

CertificateChain => Str

[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

CertificateName => Str

The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

CertificatePrivateKey => Str

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

REQUIRED DomainName => Str

[Required] The name of the DomainName resource.

EndpointConfiguration => Paws::ApiGateway::EndpointConfiguration

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

RegionalCertificateArn => Str

The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

RegionalCertificateName => Str

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateDomainName in Paws::ApiGateway

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config