Array shapes / Object return types?

[brendandebeasi]

The AWS API is very complex. I would love if we could utilize array shapes or defined objects. This way I can get typehinting in my IDE

https://blog.jetbrains.com/phpstorm/2021/07/phpstorm-2021-2-release/#Array_shapes_PHPDoc_syntax_support

[brendandebeasi]

Something like this

<?php
namespace App\Services\Aws\Models;

use JetBrains\PhpStorm\ArrayShape;
use Aws\Api\DateTimeResult;
/**
 * This class is INCOMPLETE! Something is better than nothing
 */
class Ec2Instance
{
    #[ArrayShape([
        'AmiLaunchIndex' => 'int',
        'ImageId' => 'string',
        'InstanceId' => 'string',
        'InstanceType' => 'string',
        'LaunchTime' => DateTimeResult::class,
        'Monitoring' => [
            'State' => 'string'
        ],
        'Placement' => [
            'AvailabilityZone' => 'string',
            'GroupName' => 'string',
            'Tenancy' => 'string'
        ],
        'PrivateDnsName' => 'string',
        'PrivateIpAddress' => 'string',
        'ProductCodes' => [],
        'PublicDnsName' => 'string',
        'State' => [
            'Code' => 'int',
            'Name' => 'string',
        ],
        'StateTransitionReason' => 'string',
        'SubnetId' => 'string',
        'VpcId' => 'string',
        'Architecture' => 'string',
        'BlockDeviceMappings' =>  [],
        'ClientToken' => 'string',
        'EbsOptimized' => 'bool',
        'EnaSupport' => 'bool',
        'Hypervisor' => 'string',
        'NetworkInterfaces' => [
            [
                'Attachment' => [
                    'AttachTime' => DateTimeResult::class,
                    'AttachmentId' => 'string',
                    'DeleteOnTermination' => 'bool',
                    'DeviceIndex' => 'int',
                    'Status' => 'string',
                    'NetworkCardIndex' => 'int',
                ],
                'Description' => 'string',
                'Groups' => [
                    [
                        'GroupName' => 'string',
                        'GroupId' => 'string',
                    ]
                ],
                'Ipv6Addresses' => [],
                'MacAddress' => 'string',
                'NetworkInterfaceId' => 'string',
                'OwnerId' => 'string',
                'PrivateDnsName' => 'string',
                'PrivateIpAddress' => 'string',
                'PrivateIpAddresses' => [
                    [
                        'Primary' => 'bool',
                        'PrivateDnsName' => 'string',
                        'PrivateIpAddress' => 'string'
                    ]
                ],
                'SourceDestCheck' => 'bool',
                'Status' => 'string',
                'SubnetId' => 'string',
                'VpcId' => 'string',
                'InterfaceType' => 'string'
            ],
        ],
        'RootDeviceName' => 'string',
        'RootDeviceType' => 'string',
        'SecurityGroups' => [
            [
                'GroupName' => 'string',
                'GroupId' => 'string',
            ],
        ],
        'SourceDestCheck' => 'bool',
        'Tags' => [
            [
                'Key' => 'string',
                'Value' => 'string'
            ]
        ],
        'VirtualizationType' => 'string',
        'CpuOptions' =>  [
            'CoreCount' => 'int',
            'ThreadsPerCore' => 'int'
        ],
        'CapacityReservationSpecification' => [
            'CapacityReservationPreference' => 'string'
        ],
        'HibernationOptions' => [
            'Configured' => 'bool'
        ],
        'MetadataOptions' => [
            'State' => 'string',
            'HttpTokens' => 'string',
            'HttpPutResponseHopLimit' => 'int',
            'HttpEndpoint' => 'string',
            'HttpProtocolIpv6' => 'string',
            'InstanceMetadataTags' => 'string'
        ],
        'EnclaveOptions' => [
            'Enabled' => 'bool'
        ],
        'PlatformDetails' => 'string',
        'UsageOperation' => 'string',
        'UsageOperationUpdateTime' => DateTimeResult::class,
        'PrivateDnsNameOptions' => [
            'HostnameType' => 'string',
            'EnableResourceNameDnsARecord' => 'bool',
            'EnableResourceNameDnsAAAARecord' => 'bool'
        ],
        'MaintenanceOptions' => [
            'AutoRecovery' => 'string'
        ]
    ])] public array $data;
    public function __construct(
        array $data
    ) {
        $this->data = $data;
    }

}